![我要研发网[www.51dev.com]](/templets/images/toplogo.gif)
OK，那么我们先看看Javadoc是如何生成漂亮的文档!将上面的代码保存到JavaDocTest.java并编译。
运行：javadoc -private -d doc -auth
or -version JavaDocTest.java
这时，Javadoc程序会根据JavaDocTest.java生成一个doc目录，里面有很多HTML文件，这些就是Javadoc生成的API帮助文档。
Javadoc命令行语法
光会使用标记还不能很好利用Javadoc提供的功能，必须能使用它的命令行才行。最后向大家介绍一下简单的Javadoc命令。
Javadoc的命令行语法如下：
javadoc options packagenames sourcefiles @files
提示：对于一般的应用，我们只须使用javadoc yourjavafile.java这样的命令行生成帮助文档就行了。如果你需要定制帮助文档，才会用到参数，一般情况下你可以使用javadoc help命令来查看Javadoc的帮助文档。
总之，Javadoc提供了完整规范的API文档功能。在软件项目管理和开发中，合理地使用Javadoc不仅可以减少开发时的文档工作量，提高效率，而且还非常有利于将来软件的修改和维护。
Javadoc标记的一些详细说明：
字串2
@author指定生成文档中的“作者”项，可以指定多个author。在左面的代码中，author后面还加了一个HTML标记，用来链接URL。都是HTML标记，<-- 则是HTML注释。
@version指定版本信息。
@see标记是比较复杂的。@see″string″为“string”添加文本项，不产生任何链接。@see Label 使用HTML标记产生链接。@see package.class#member Label。
@param标记用来描述参数。
@return标记用来描述返回值。
@link为内联标记，内联标记的通常格式是：@linkpackage.class#member label
提示：Label是位于注释中间的文本，package.class#member指向一个具体的类或者方法。以下是一些例子：
链接到同一类的属性，使用：@link#KEY
链接到同一类的方法，使用：@link#getComponentAtintgetComponentAt
链接到其它类，使用@linkjava.util.Map Map