JavaDoc的生成规则---ShinePans

使用方法: 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>     指定查找用户类文件的位置

-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> 的程序包列表链接至位于

的文档

-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 的路径

-Xdocrootparent <url>             将文档凝视中出现的全部后跟 /.. 的 @doc

换为 <url>

-charset <charset>                用于跨平台查看生成的文档的字符集。

-helpfile <file>                  包括帮助链接所链接到的文件

-linksource                       以 HTML 格式生成源文件

-sourcetab <tab length>           指定源中每一个制表符占领的空格数

-keywords                         使程序包, 类和成员信息附带 HTML 元标记

-stylesheetfile <path>            用于更改生成文档的样式的文件

-docencoding <name>               输出编码名称