如何使用Javadoc

Javadoc

简介

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。

Javadoc命令格式如下：

javadoc [选项] [软件包名称] [源文件]
其中选项有：
-overview <文件> 读取 HTML 文件的概述文档
-public 仅显示公共类和成员
-protected 显示受保护/公共类和成员（默认）
-package 显示软件包/受保护/公共类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <类> 通过替代 doclet 生成输出
-docletpath <路径> 指定查找 doclet 类文件的位置
-sourcepath <路径列表> 指定查找源文件的位置
-classpath <路径列表> 指定查找用户类文件的位置
-exclude <软件包列表> 指定要排除的软件包的列表
-subpackages <子软件包列表> 指定要递归装入的子软件包
-breakiterator 使用 BreakIterator 计算第 1 句
-bootclasspath <路径列表> 覆盖引导类加载器所装入的类文件的位置
-source <版本> 提供与指定版本的源兼容性
-extdirs <目录列表> 覆盖安装的扩展目录的位置
-verbose 输出有关 Javadoc 正在执行的操作的消息
-locale <名称> 要使用的语言环境，例如 en_US 或 en_US_WIN
-encoding <名称> 源文件编码名称
-quiet 不显示状态消息
-J<标志> 直接将 <标志> 传递给运行时系统

Javadoc在Eclipse中的使用

程序的注释和文档可以说跟代码一样非常重要，良好的注释和代码会使软件以后的维护工作变得轻松。千万不要忽视这些注释和文档，一定要认真对待。这里简单说下关于javadoc的应用。
首先，你的注释必须符合一定的格式。这里，必须在/**和 */之间。例如：

package src;

/**

• @author hwoarangzk

• @version 1.0

• @since 2007.02.21

*/

public class A {

/**

• Just a method

• @param args A ArrayList arguments of type String

*/
public static void main(String args[]) {

System.out.println(“Hello world!”);

}

/**

• @return Null No value returned

*/
public int methodTest() {

return 1;

}

}
也就是说，//和在/**… * /之间的注释是不会被转换为文档的。一般注释都放在类、方法和变量前面。
我们可以在注释中添加一些信息，例如作者、版本等等。它们都以@开头，放在后面，例如以上的例子。下面介绍些常用的。
@author 作者信息:作者的信息
@version 版本信息:版本的信息
@since:指定程序代码最早使用的版本
@param 参数名称 参数描述:放在方法前面，参数名称要和参数列表中的名称相符合
@return 返回描述:描述方法返回值的信息，void方法不能使用这个注释
@throws 异常类名称 异常描述:描述方法中的异常信息
此外，还有更多其他的注释内容，可以去Sun官网查看。
在Eclipse中，如果想名称为A的类生成文档，那么，写好一个文件后（包括注释），在左边的Package Explorer中右键单击该文件，选择Export—>Java—>Javadoc，再选择好一个输出的路径就可以finish了。然后去这个路径就能够查看到相应文档了。