Javadoc（文档注释）详解

矫情吗；* 2023-09-24 14:32 59阅读 0赞

[Java][] 支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以`/**`开头，并以`*/`结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。  
  
文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。  
  
Javadoc 是 Sun 公司提供的一种工具，它可以从程序源代码中抽取类、方法、成员等注释，然后形成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时以一套特定的标签注释，在程序编写完成后，通过 Javadoc 就形成了程序的 API 帮助文档。

> API 帮助文档相当于产品说明书，而说明书只需要介绍那些供用户使用的部分，所以 Javadoc 默认只提取 public、protected 修饰的部分。如果要提取 private 修饰的部分，需要使用 -private。

### Javadoc标签 ###

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以`@`开头，后跟一个指定的名字，有的也以`{@`开头，以`}`结束。Javadoc 可以识别的标签如下表所示：

<table> 
 <tbody> 
  <tr> 
   <th>标签</th> 
   <th>描述</th> 
   <th>示例</th> 
  </tr> 
  <tr> 
   <td>@author</td> 
   <td>标识一个类的作者，一般用于类注释</td> 
   <td>@author description</td> 
  </tr> 
  <tr> 
   <td>@deprecated</td> 
   <td>指名一个过期的类或成员，表明该类或方法不建议使用</td> 
   <td>@deprecated description</td> 
  </tr> 
  <tr> 
   <td>{@docRoot}</td> 
   <td>指明当前文档根目录的路径</td> 
   <td>Directory Path</td> 
  </tr> 
  <tr> 
   <td>@exception</td> 
   <td>可能抛出异常的说明，一般用于方法注释</td> 
   <td>@exception exception-name explanation</td> 
  </tr> 
  <tr> 
   <td>{@inheritDoc}</td> 
   <td>从直接父类继承的注释</td> 
   <td>Inherits a comment from the immediate surperclass.</td> 
  </tr> 
  <tr> 
   <td>{@link}</td> 
   <td>插入一个到另一个主题的链接</td> 
   <td>{@link name text}</td> 
  </tr> 
  <tr> 
   <td>{@linkplain}</td> 
   <td>插入一个到另一个主题的链接，但是该链接显示纯文本字体</td> 
   <td>Inserts an in-line link to another topic.</td> 
  </tr> 
  <tr> 
   <td>@param</td> 
   <td>说明一个方法的参数，一般用于方法注释</td> 
   <td>@param parameter-name explanation</td> 
  </tr> 
  <tr> 
   <td>@return</td> 
   <td>说明返回值类型，一般用于方法注释，不能出现再构造方法中</td> 
   <td>@return explanation</td> 
  </tr> 
  <tr> 
   <td>@see</td> 
   <td>指定一个到另一个主题的链接</td> 
   <td>@see anchor</td> 
  </tr> 
  <tr> 
   <td>@serial</td> 
   <td>说明一个序列化属性</td> 
   <td>@serial description</td> 
  </tr> 
  <tr> 
   <td>@serialData</td> 
   <td>说明通过 writeObject() 和&nbsp;writeExternal() 方法写的数据</td> 
   <td>@serialData description</td> 
  </tr> 
  <tr> 
   <td>@serialField</td> 
   <td>说明一个 ObjectStreamField 组件</td> 
   <td>@serialField name type description</td> 
  </tr> 
  <tr> 
   <td>@since</td> 
   <td>说明从哪个版本起开始有了这个函数</td> 
   <td>@since release</td> 
  </tr> 
  <tr> 
   <td>@throws</td> 
   <td>和 @exception 标签一样.</td> 
   <td>The @throws tag has the same meaning as the @exception tag.</td> 
  </tr> 
  <tr> 
   <td>{@value}</td> 
   <td>显示常量的值，该常量必须是 static 属性。</td> 
   <td>Displays the value of a constant, which must be a static field.</td> 
  </tr> 
  <tr> 
   <td>@version</td> 
   <td>指定类的版本，一般用于类注释</td> 
   <td>@version info</td> 
  </tr> 
 </tbody> 
</table>

对两种标签格式的说明：

*  @tag 格式的标签（不被`{ }`包围的标签）为块标签，只能在主要描述（类注释中对该类的详细说明为主要描述）后面的标签部分（如果块标签放在主要描述的前面，则生成 API 帮助文档时会检测不到主要描述）。
 *  \{@tag\} 格式的标签（由`{ }`包围的标签）为内联标签，可以放在主要描述中的任何位置或块标签的注释中。

Javadoc 标签注意事项：

*  Javadoc 标签必须从一行的开头开始，否则将被视为普通文本。
 *  一般具有相同名称的标签放在一起。
 *  Javadoc 标签区分大小写，代码中对于大小写错误的标签不会发生编译错误，但是在生成 API 帮助文档时会检测不到该注释内容。

### Javadoc命令 ###

Javadoc 用法格式如下：

> javadoc \[options\] \[packagenames\] \[sourcefiles\]

对格式的说明：

*  options 表示 Javadoc 命令的选项；
 *  packagenames 表示包名；
 *  sourcefiles 表示源文件名。

在 cmd（命令提示符）中输入`javadoc -help`就可以看到 Javadoc 的用法和选项（前提是安装配置了JDK），下面列举 Javadoc 命令的常用选项：

<table> 
 <tbody> 
  <tr> 
   <th>名称</th> 
   <th>说明</th> 
  </tr> 
  <tr> 
   <td>-public</td> 
   <td>仅显示 public 类和成员</td> 
  </tr> 
  <tr> 
   <td>-protected</td> 
   <td>显示 protected/public 类和成员（默认值）</td> 
  </tr> 
  <tr> 
   <td>-package</td> 
   <td>显示 package/protected/public 类和成员</td> 
  </tr> 
  <tr> 
   <td>-private</td> 
   <td>显示所有类和成员</td> 
  </tr> 
  <tr> 
   <td>-d &lt;directory&gt;</td> 
   <td>输出文件的目标目录</td> 
  </tr> 
  <tr> 
   <td>-version</td> 
   <td>包含 @version 段</td> 
  </tr> 
  <tr> 
   <td>-author</td> 
   <td>包含 @author 段</td> 
  </tr> 
  <tr> 
   <td>-splitindex</td> 
   <td>将索引分为每个字母对应一个文件</td> 
  </tr> 
  <tr> 
   <td>-windowtitle &lt;text&gt;</td> 
   <td>文档的浏览器窗口标题</td> 
  </tr> 
 </tbody> 
</table>

### DOS命令生成API帮助文档 ###

新建一个空白记事本，输入下列代码：

/**
    * @author C语言中文网
    * @version jdk1.8.0
    */
    public class Test{
        /**
         * 求输入两个参数范围以内整数的和
         * @param n 接收的第一个参数，范围起点
         * @param m 接收的第二个参数，范围终点
         * @return 两个参数范围以内整数的和
         */
        public int add(int n, int m) {
            int sum = 0;
            for (int i = n; i <= m; i++) {
                sum = sum + i;
            }
            return sum;
        }
    }

将文件命名为 Test.java，打开 cmd 窗口，输入`javadoc -author -version Test.java`命令。如图 1 所示。

![6c077d6c02458d32e9f8d3b28d060692.png][]

## 打开 Test.java 文件存储的位置，会发现多出了一个 Test.html 文档。打开文档，文档页面如图 2 和图 3 所示。 ##

![6bae3fcbec598925fd8a257fe3cd65af.png][]

注意：以上没有考虑编码格式的问题，注释中有汉字可能会乱码。使用`javadoc -encoding UTF-8 -charset UTF-8 Test.java`会解决编码问题。

## 使用IDEA生产JavaDoc文档 ##

## [学会使用idea生成JavaDoc文档![icon-default.png?t=M85B][icon-default.png_t_M85B]https://www.cnblogs.com/hyxdz/p/15958937.html][idea_JavaDoc_icon-default.png_t_M85B_icon-default.png_t_M85B_https_www.cnblogs.com_hyxdz_p_15958937.html] ##

1.创建一个存放JavaDoc的文件夹。

2.打开idea上方工具（Tools）,生成JavaDoc文档（Generate JavaDoc...）

![e17dd1468e03a46cc65eb93cdfdc263f.png][]

3.选择我们要生成的类。

4.在output directory中选择我们刚才建立的存放JavaDoc的文件路径。

5.然后再Locale和其他命令行参数输入如下代码，以防止中文带来的乱码。

![02a4de02f19ca7aaabd190e0d5db3798.png][]

6.进入存放JavaDoc 文件中点击index.html即可看到我们生成的JavaDoc文档。

![0dcf7ee565475cdcc54beb8f8e56b189.png][]

[Java]: http://c.biancheng.net/java/
[6c077d6c02458d32e9f8d3b28d060692.png]: https://img-blog.csdnimg.cn/img_convert/6c077d6c02458d32e9f8d3b28d060692.png
[6bae3fcbec598925fd8a257fe3cd65af.png]: https://img-blog.csdnimg.cn/img_convert/6bae3fcbec598925fd8a257fe3cd65af.png
[icon-default.png_t_M85B]: https://csdnimg.cn/release/blog_editor_html/release2.2.0/ckeditor/plugins/CsdnLink/icons/icon-default.png?t=M85B
[idea_JavaDoc_icon-default.png_t_M85B_icon-default.png_t_M85B_https_www.cnblogs.com_hyxdz_p_15958937.html]: https://www.cnblogs.com/hyxdz/p/15958937.html
[e17dd1468e03a46cc65eb93cdfdc263f.png]: https://img-blog.csdnimg.cn/img_convert/e17dd1468e03a46cc65eb93cdfdc263f.png
[02a4de02f19ca7aaabd190e0d5db3798.png]: https://img-blog.csdnimg.cn/img_convert/02a4de02f19ca7aaabd190e0d5db3798.png
[0dcf7ee565475cdcc54beb8f8e56b189.png]: https://img-blog.csdnimg.cn/img_convert/0dcf7ee565475cdcc54beb8f8e56b189.png