Java文档及Javadoc
除了包之外，Java文档也是Java编程中非常重要的一个概念。Java文档就是Java程序的帮助文档。一般情况下，我们先写好帮助文档，再利用工具Javadoc来生成相应的文档。Javadoc是JDK提供的一个文档生成工具，它利用Java编译程序Javac对程序代码源文件中的声明和文档注释进行语法分析，并在默认情况下生成一组HTML文档来描述类、内部类、接口、构造函数、方法和域。Javadoc注释以“/”开始，以“/”结束，里面可以包含普通文本、HTML标记和Javadoc标记。Javadoc只处理源文件中在类/接口定义、方法、域、构造器之前的注释，忽略其它地方的注释。
掌握Javadoc
现在我们先用一个例程来说明Javadoc标记的意义：
/
我的JavaDoc测试程序--JavaDocTest
@author warton2003西安
test<--这里可以嵌入HTML本句为HTML注释-->
@version 0.1 2004/01/01
/
public class JavaDocTest
/
在main中要使用字符串
@see #mainjava.lang.String
/
static String SDisplay
/
显示Javadoc测试
@param args命令行参数
@return没有返回值
/
public static void mainString args
SDisplay =″Javadoc测试″
System.out.printlnSDisplay
在这个Java程序里面，使用了大量的Javadoc标记、文本以及HTML标记。Javadoc标记以“/”开始，表明这些都是Java代码的注释。“@”开头的标记就是Javadoc标记。
Javadoc标记有两种：独立(Standalone)标记和内联(Inline)标记。独立标记也就是那些常见的标记，如@param、@return和@author等；另一种类型的标记是内联标记这种标记采用@tag的形式它允许开发者创建超级链接从注释部分链接到其它的Javadoc页面或者本页面的其它地方。
提示：在Java源程序里正确使用Javadoc标记是非常必要的注释习惯，将有助于Javadoc自动以源代码文件生成完整的格式化API文档。
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标记的一些详细说明：
@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
<<上一页
1
2
|
