javadoc

>javadoc -help
用法: javadoc [options] [packagenames] [sourcefiles] [@files]
-overview <file> 从 HTML 文件读取概览文档
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (默认值)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <class> 通过替代 doclet 生成输出
-docletpath <path> 指定查找 doclet 类文件的位置
-sourcepath <pathlist> 指定查找源文件的位置
-classpath <pathlist> 指定查找用户类文件的位置
-cp <pathlist> 指定查找用户类文件的位置
-exclude <pkglist> 指定要排除的程序包列表
-subpackages <subpkglist> 指定要递归加载的子程序包
-breakiterator 计算带有 BreakIterator 的第一个语句
-bootclasspath <pathlist> 覆盖由引导类加载器所加载的类文件的位置
-source <release> 提供与指定发行版的源兼容性
-extdirs <dirlist> 覆盖所安装扩展的位置
-verbose 输出有关 Javadoc 正在执行的操作的信息
-locale <name> 要使用的区域设置, 例如 en_US 或 en_US_WIN
-encoding <name> 源文件编码名称
-quiet 不显示状态消息
-J<flag> 直接将 <flag> 传递到运行时系统
-X 输出非标准选项的提要

通过标准 doclet 提供:
-d <directory> 输出文件的目标目录
-use 创建类和程序包用法页面
-version 包含 @version 段
-author 包含 @author 段
-docfilessubdirs 递归复制文档文件子目录
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题
-doctitle <html-code> 包含概览页面的标题
-header <html-code> 包含每个页面的页眉文本
-footer <html-code> 包含每个页面的页脚文本
-top <html-code> 包含每个页面的顶部文本
-bottom <html-code> 包含每个页面的底部文本
-link <url> 创建指向位于 <url> 的 javadoc 输出的链接
-linkoffline <url> <url2> 利用位于 <url2> 的程序包列表链接至位于 <url>的文档
-excludedocfilessubdir <name1>:.. 排除具有给定名称的所有文档文件子目录。
-group <name> <p1>:<p2>.. 在概览页面中, 将指定的程序包分组
-nocomment 不生成说明和标记, 只生成声明。
-nodeprecated 不包含 @deprecated 信息
-noqualifier <name1>:<name2>:... 输出中不包括指定限定符的列表。
-nosince 不包含 @since 信息
-notimestamp 不包含隐藏时间戳
-nodeprecatedlist 不生成已过时的列表
-notree 不生成类分层结构
-noindex 不生成索引
-nohelp 不生成帮助链接
-nonavbar 不生成导航栏
-serialwarn 生成有关 @serial 标记的警告
-tag <name>:<locations>:<header> 指定单个参数定制标记
-taglet 要注册的 Taglet 的全限定名称
-tagletpath Taglet 的路径
-charset <charset> 用于跨平台查看生成的文档的字符集。
-helpfile <file> 包含帮助链接所链接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab <tab length> 指定源中每个制表符占据的空格数
-keywords 使程序包, 类和成员信息附带 HTML 元标记
-stylesheetfile <path> 用于更改生成文档的样式的文件
-docencoding <name> 指定输出的字符编码

使用格式 ：
>javadoc -d TestApiDoc -windowtitle 测试 -doctitle 测试生成API文档 -header 我的类名 *.java
正在加载源文件CommentTest.java...
正在加载源文件JavadocTagTest.java...
正在加载源文件JavadocTest.java...
正在加载源文件Test.java...
正在构造 Javadoc 信息...
正在创建目标目录: "TestApiDoc\"
标准 Doclet 版本 1.8.0_31
正在构建所有程序包和类的树...
正在生成TestApiDoc\CommentTest.html...
正在生成TestApiDoc\yeeku\JavadocTagTest.html...
正在生成TestApiDoc\yeeku\Test.html...
正在生成TestApiDoc\lee\JavadocTest.html...
正在生成TestApiDoc\overview-frame.html...
正在生成TestApiDoc\package-frame.html...
正在生成TestApiDoc\package-summary.html...
正在生成TestApiDoc\package-tree.html...
正在生成TestApiDoc\lee\package-frame.html...
正在生成TestApiDoc\lee\package-summary.html...
正在生成TestApiDoc\lee\package-tree.html...
正在生成TestApiDoc\yeeku\package-frame.html...
正在生成TestApiDoc\yeeku\package-summary.html...
正在生成TestApiDoc\yeeku\package-tree.html...
正在生成TestApiDoc\constant-values.html...
正在构建所有程序包和类的索引...
正在生成TestApiDoc\overview-tree.html...
正在生成TestApiDoc\index-all.html...
正在生成TestApiDoc\deprecated-list.html...
正在构建所有类的索引...
正在生成TestApiDoc\allclasses-frame.html...
正在生成TestApiDoc\allclasses-noframe.html...
正在生成TestApiDoc\index.html...
正在生成TestApiDoc\overview-summary.html...
正在生成TestApiDoc\help-doc.html...
>

源文件中的javadoc 标记有如下一些：
标记 用于 作用
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@deprecated 不推荐使用的方法 不推荐使用的方法
@see 对类、属性、 方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
@throws 抛出的异常 和exception同义

这些标记有使用位置的限制。
可以出现在类或接口文档注释的有：@author @version @deprecated @see
可以出现在方法或构造器文档的有：@deprecated @see @param @return @exception @throws
可以出现在Field文档注释的有： @see @deprecated

其中：@author @version 这两个标记分别用于指明类的作者和版本。缺省情况下 javadoc 将其忽略，但命令行开关 -author 和 -version 可以修改这个功能，使其包含的信息被输出。
@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。
@version 也可以使用多次，只有第一次有效，生成的文档中只会显示第一次使用 @version 指明的版本号。

@param 只能描述方法的一个参数，所以，如果方法需要多个参数，就需要多次使用 @param 来描述
@return 一个方法中只能用一个，如果文档说明中列了多个 @return，则 javadoc 编译时会发出警告，且只有第一个 @return 在生成的文档中有效
方法可能抛出的异常应当用 @exception 描述。由于一个方法可能抛出多个异常，所以可以有多个 @exception。每个 @exception 后面应有简述的异常类名，说明中应指出抛出异常的原因。需要注意的是，异常类名应该根据源文件的 import 语句确定是写出类名还是类全名。

转载于:https://www.cnblogs.com/lzhat/p/4420066.html