JDK tools-javadoc

JDK工具包-javadoc，从java源文件生成API文档的HTML页面

javadoc工具解析一组java源文件中的声明和文档注释，并生成响应的HTML页面，这些页面描述(默认情况下)公共和保护属性的类、接口、构造函数、方法、字段。你可以使用javadoc工具为一组源文件生成API文档。

javadoc注释

javadoc注释的格式:
    /**
     * test
     * @param text
     * @return
     */

常见的参数:
@author 作者名
@version 版本号
@since 版本号，指明从哪个版本起开始有这个方法
@param 方法的参数
@return 标明返回值类型，一般用于方法注释
@exception 可能抛出异常的说明
@throws 可能抛出异常的说明

命令行生成javadoc文档

javadoc [options] [packagenames] [sourcefiles] [@files]
options:选项
指定命令行选项，以空格分隔
常用的选项:
-encoding
对javadoc工具读取的文件进行编码
eg:
-encoding UTF-8

-charset
对javadoc工具写入的文件进行编码
eg:
-charset UTF-8

-d
指定生成的HTML输出路径

packagename:包名
指定要记录的包的名称，以空格分隔。例如 java.lang，java.awt。如果还想记录子包，使用-subpackages选项来指定包。
默认情况下，javadoc在当前目录和子目录中查找指定的包。使用-sourcepath选项指定要在其中查找包的目录列表。

sourcefiles:源文件
指定要记录的java源文件的名称，以空格分隔。例如：Class.java Button.java。默认情况下，javadoc在当前目录中查找指定的类。但是你可以指定类文件的完整路径并使用通配符。例如/home/src/java/awt/Test*.java。还可以指定相对与当前目录的路径。

@files:文件名
指定包含javadoc工具选项列表、包名、任意顺序的源文件名的文件名。

eg: 指定Test.java类生成javadoc文档，输出到doc文件夹下
javadoc -encoding UTF-8 -charset UTF-8 -d doc Test.java