Java文档工具javaDoc

Java语言一个独特且特别有用的功能就是javadoc工具，使用该工具，可以获取Java源代码中的注释，并生成HTML页面。这就鼓励开发者在代码中添加注释，因为产生的HTML网页可以让同事和其他需要了解一个类的人所用，并且不需要看实际的源代码。

Java SE API的文档就是使用javadoc工具生成的。该文档可以在Sun的网站http://java.sun.com/javase上找到。我们可以下载该文档，也可以在线浏览。

运行javadoc工具可以为每个类创建HTML页面，页面中包含有类的详细信息。类页面的信息包括类的继承层次、字段的摘要、构造器和方法，以及每个字段、构造器和方法的详细描述。

与类的通用信息有关的注释直接出现在类声明之前，而与类的字段、方法或构造器有关的注释直接出现在类成员声明之前。此外，我们还可以使用如下javadoc标记之一来表述特定类型的注释信息：

• @author：表示源代码的作者名称。
• @depracated：表示随着程序版本的提升，当前类成员已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。
• {@docRoot}：代表当前页面要输出到的针对于根目录的相对路径。
• @exception：被方法所用，列出抛出的异常。
• {@link 包.类#成员的链接文字}：创建一个对特定类成员的链接。
• {@linkplain 包.类#成员的链接文字}：如{@link}相同，但是用纯文本字体代替了代码字体。
• @param：用于描述方法的形式参数。
• @return：用于描述方法的返回值。
• @see：创建一个“参见”XX条目的链接，如类、方法、变量等。
• @since：描述成员存在或改变时的版本号。
• @serial、@serialField和@serialData：用于串行化用途。
• @throws：与@exception标记相同。
• {@value}：用于显示常量静态字段的值。
• @version：描述类的软件版本。