JavaDoc注释注意事项
下文笔者讲述JavaDoc注释的规范说明
JavaDoc注释简介
JavaDoc 是Java代码的一种注释风格 我们按照这种风格定义注释信息后 可使用JavaDoc命令生成API文档
JavaDoc常用标签说明
| 标签 | 备注 | 标签类型 |
| @author | 作者 | 作者标识 包，类，接口 |
| @version | 版本号 | 包，类，接口 |
| @param | 参数 | 方法的入参及描述信息，如入参有特别要求，可在此注释 构造函数，方法 |
| @return | 描述 | 对函数返回值的注释 方法 |
| @deprecated | 过期文本 | 标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个APi 包，类，接口，值域，构造函数，方法 |
| @throws | 异常 | 构造函数或方法所会抛出的异常 构造函数，方法 |
| @exception | 异常类名 | 同@throws 构造方法，方法 |
| @see | 引用 | 查看相关，如类，方法，变量 包，类，接口，值域，构造函数，方法 |
| @since | 描述文本 | API在什么程序的什么版本后开始支持 包，类，接口，值域，构造函数，方法 |
| @value | 当对常量进行注释时如果想将其值包含在文档中，则通过该标签来引用常量的值 静态值域 | |
| 此处还有@serial，@serialField，@serialData，{@docRoot}，{@inheritDoc}，{@literal}，{@code}，{@value arg}这几个不常用的标签，由于不常使用，这里不展开叙述，感兴趣的读者可以查看帮助文档。 | ||
JavaDoc命令操作说明
javadoc [选项] [软件包名称] 选项可使用以下信息 -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<标志> 直接将 <标志> 传递给运行时系统
版权声明
本文仅代表作者观点，不代表本站立场。
本文系作者授权发表，未经许可，不得转载。
