java开发工具之一 javadoc

 功能说明 ：
　　Java API文档生成器从Java源文件生成API文档HTML页。

语法：
　　javadoc [ 命令选项 ] [ 包名 ] [ 源文件名 ] [ @files ]
　　其中[ 包名 ]为用空格分隔的一系列包的名字，包名不允许使用通配符，如（*）。
        [ 源文件名 ]为用空格分隔的一系列的源文件名，源文件名可包括路径和通配符，如（*）。
        [ @files ]是以任何次序包含包名和源文件的一个或多个文件。

命令选项：
-d directory 指定javadoc保存生成的HTML件的目的目录。省略该选项将导致把文件保存到当前目录中。其中directory可以是绝对路径或相对当前工作目录的相对路径。
-sourcepath sourcepathlist 当将包名传递到javadoc命令中时，指定定位源文件（.java）的搜索路径。注意只有当用 javadoc命令指定包名时才能使用sourcepath选项 -- 它将不会查找传递到javadoc命令中的.java文件。如果省略-sourcepath，则javadoc使用类路径查找源文件。
-locale language_country_variant 指定javadoc在生成文档时使用的环境。
-encoding name 指定源文件编码名，例如EUCJIS/SJIS。如果未指定该选项，则使用平台缺省转换器。

-windowtitle[title] 窗口标题
-doctitle[title] 文档标题
-header[title] 页头
-footer[title] 页脚
-bottom[title] 文档底部

-public 只显示公有类及成员。
-protected 只显示受保护的和公有的类及成员。这是缺省状态。
-package 只显示包、受保护的和公有的类及成员。
-private 显示所有类和成员。
-verbose 在javadoc运行时提供更详细的信息。不使用verbose选项时，将显示加载源文件、生成文档（每个源文件一条信息）和排序的信息。verbose选项导致打印额外的信息，指定解析每个java源文件的毫秒数
-splitindex 将索引文件按字母分割成多个文件，每个字母一个文件，再加上一个包含所有以非字母字符开头的索引项的文件。
-version 在生成文档中包括 @version 文本。缺省地将省略该文本
-author 在生成文档中包括 @author 文本
-use 对每个带文档类和包包括一个“用法”页。该页描述使用给定类或包的任何 API 的包、类、方法、构造函数和域。对于给定类 C，使用类 C 的任何东西将包括 C 的子类、声明为 C 的域、返回 C 的方法以及具有 C 类型参数的方法和构造函数。
-help 显示联机帮助，它将列出这些javadoc和doclet命令行选项。