java中doc注释

javadoc注释官方参考网站1

javadoc注释官方参考网站2

一、注释：

{@inheritDoc}

// 代表从父类或父接口继承注释
{@inheritDoc}

二、javadoc命令参数：

javadoc: 错误 - 无效的标记: -Description
用法: 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                        输出非标准选项的提要

标准 Standard doclet 提供以下参数：
-d <directory>                    输出文件的目标目录
-use                              创建类和包用法页面
-version                          包含 @version 段
-author                           包含 @author 段
-docfilessubdirs                  递归复制 doc-file 子目录
-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>:.. 排除具有指定名称的任何 doc-files 子目录
-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>             将文档注释中出现的 @docRoot（后跟 /..）替换为 <url>
-charset <charset>                用于跨平台查看所生成文档的字符集
-helpfile <file>                  包含帮助链接所链接到的文件
-linksource                       生成 HTML 格式的源代码
-sourcetab <tab length>           指定源代码中每个跳格所占用的空格数
-keywords                         在 HTML META 标记中包含包、类和成员信息
-stylesheetfile <path>            要更改所生成文档的样式的文件
-docencoding <name>               输出编码名称