Skip to main content

Javadoc （Java API 文档生成器）详解

Java 支持 3 种注释，分别是单行注释、多行注释和文档注释。文档注释以/**开头，并以*/结束，可以通过 Javadoc 生成 API 帮助文档，Java 帮助文档主要用来说明类、接口、方法、成员变量、构造器和内部类。

Javadoc 是 Sun 公司提供的一种工具，它只处理文档源文件在类、接口、方法、成员变量、构造器和内部类之前的注释，忽略其他地方的文档注释，然后形成一个和源代码配套的 API 帮助文档。也就是说，只要在编写程序时在文档注释中以一套特定的标签注释，在程序编写完成后，通过 Javadoc 就形成了程序的 API 帮助文档。

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

javadoc标签​

Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@`开头，以`}结束。这些 doc 标签使您能够从源代码自动生成完整的、格式良好的 API。标签以@开头，并且区分大小写——它们必须使用大写和小写字母输入。标签必须在行首开始，否则将被视为普通文本。按照惯例，具有相同名称的标签被组合在一起。例如，将所有 @see标签放在一起。

对两种标签格式的说明：

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

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

javadoc命令​

javadoc 命令语法格式如下：

javadoc [options] [packagenames] [sourcefilenames] [-subpackages pkg1:pkg2:...] [@argfiles]

对格式的说明：

  • options 表示 Javadoc 命令的选项。
  • packagenames 表示包名。
  • sourcefiles 表示源文件名。
  • -subpackages pkg1:pkg2:…：从指定包中的源文件并在其子包中递归生成文档。
  • @argfiles：一个或多个文件，其中包含以任何顺序排列的 Javadoc 选项、包名和源文件名列表。

在 cmd（命令提示符）中输入

javadoc -help就可以看到 Javadoc 的用法和选项，下面列举 Javadoc 命令的常用选项：

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

使用javadoc DOS命令生成API文档​

首先新建一个名java类，输入以下代码:​

/**
 * @author Penguin
 * @version jdk1.8.0
 */
public class javadoc {
    /**
     * 求输入两个参数范围以内整数的和
     * @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;
    }
}

在cmd窗口找到代码目录，输入命令:​

  • javadoc -author -version Test.java命令，此命令没有考虑编码格式问题，注释中有汉字可能会乱码。

javadoc -encoding UTF-8 -charset UTF-8 Test.java会解决编码问题​

代码所在的目录中将会生成.html文档文件，打开如下图所示：​

本文转自 https://zhuanlan.zhihu.com/p/599276419，如有侵权，请联系删除。