JavaDoc注释详解

作者：奋斗码农 
来源：CSDN 
原文：https://blog.csdn.net/xufei512/article/details/79803462 
版权声明：本文为博主原创文章，转载请附上博文链接！

=========================

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

javadoc标记
javadoc标记包括。

标记    说明    标记类型
@author    作者标记    包、 类、接口
@version    版本号    包、 类、接口
@param    方法的入参名及描述信息，如入参有特别要求，可在此注释。    构造函数、 方法
@return    函数返回值描述    方法
@deprecated    标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。    包、类、接口、值域、构造函数、 方法
@throws    构造函数或方法所会抛出的异常。    构造函数、 方法
@exception    构造函数或方法所会抛出的异常。    构造函数、 方法
@see    查看相关内容，如类、方法、变量等。    包、类、接口、值域、构造函数、 方法
@since    API在什么程序的什么版本后开发支持。    包、类、接口、值域、构造函数、 方法
{@link包.类#成员 标签}    链接到某个特定的成员对应的文档中。    包、类、接口、值域、构造函数、 方法
{@value}    当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。    静态值域
@see    查看相关内容，如类、方法、变量等。    包、类、接口、值域、构造函数、 方法
@serial    序列化标记    用于序列化特殊方法
@serialField    序列化标记    用于序列化ObjectStreamField组件
@serialData    序列化标记    用于序列化特殊方法
{@link}    创建内部链接    包、类、接口、值域、构造函数、方法
{@linkplain}    功能与@link相同，内容显示格式不同    包、类、接口、值域、构造函数、方法
{@docRoot}    生成html文档根目录    包、类、接口、值域、构造函数、方法
{@inheritDoc}    继承父类的注释文档    包、类、接口、值域、构造函数、方法
{@literal}    用于解析特定字符（<,>）    包、类、接口、值域、构造函数、 方法
{@code}    使内容在html文件中展示code风格    包、类、接口、值域、构造函数、 方法
标记使用
标记使用请查阅这里 
在描述性文档字段中，可兼容插入HTML标签以使生成的HTML文件更加易读。比如p,a,br等。

命令格式
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<标志> 直接将 <标志> 传递给运行时系统
--------------------- 
作者：奋斗码农 
来源：CSDN 
原文：https://blog.csdn.net/xufei512/article/details/79803462 
版权声明：本文为博主原创文章，转载请附上博文链接！