java注释 标注
Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。 Java中有三种注释方法： 1. //被注释语句 2. /*被注释语句*/ 3. /**被注释语句*/ 其中第三种专为JavaDoc设计，可以被JDK内置的JavaDoc工具支持和处理。 关键词列表 @author 作者名 @version 版本标识 @parameter 参数及其意义 @since 最早使用该方法/类/接口的JDK版本 @return 返回值 @throws 异常类及抛出条件 @deprecated 引起不推荐使用的警告 @see 交叉参考 用法 javadoc [选项] [软件包名称] [源文件] [@file] -overview <文件> 读取 HTML 文件的概述文档 -public 仅显示公共类和成员 -protected 显示受保护/公共类和成员（默认） -package 显示软件包/受保护/公共类和成员 -private 显示所有类和成员 -help 显示命令行选项并退出 -doclet <类> 通过替代 doclet 生成输出 -docletpath <路径> 指定查找 doclet 类文件的位置 -sourcepath <路径列表> 指定查找源文件的位置 -classpath <路径列表> 指定查找用户类文件的位置 -exclude <软件包列表> 指定要排除的软件包的列表 -subpackages <子软件包列表> 指定要递归装入的子软件包 -breakiterator 使用 BreakIterator 计算第 1 句 -bootclasspath <路径列表> 覆盖引导类加载器所装入的 类文件的位置 -source <版本> 提供与指定版本的源兼容性 -extdirs <目录列表> 覆盖安装的扩展目录的位置 -verbose 输出有关 Javadoc 正在执行的操作的消息 -locale <名称> 要使用的语言环境，例如 en_US 或 en_US_WIN -encoding <名称> 源文件编码名称 -quiet 不显示状态消息 -J<标志> 直接将 <标志> 传递给运行时系统 通过标准 -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 的路径 -charset <charset> 用于跨平台查看生成的文档的字符集。 -helpfile <file> 包含帮助链接所链接到的文件 -linksource 以 HTML 格式生成源文件 -sourcetab <tab length> 指定源中每个制表符占据的空格数 -keywords 使包、类和成员信息附带 HTML 元标记 -stylesheetfile <path> 用于更改生成文档的样式的文件 -docencoding <name> 输出编码名称
版权声明：本文为blogsme原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。