用法

Javadoc 插件使用 Javadoc 工具生成 javadocs。以下示例描述了插件的基本用法。

生成 Javadocs 作为项目报告的一部分

要生成 javadocs 作为站点生成的一部分，您应该在 pom 的 <reporting> 部分添加 Javadoc 插件：

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <configuration>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </reporting>
  ...
</project>

当您执行mvn site时，将生成 javadocs 并将其包含在生成的站点中。指向 javadocs 的链接将添加到 Project Reports 菜单中。

生成独立的 Javadocs

要为项目生成独立的 javadocs，您可以在 pom 的 <build> 部分添加 Javadoc 插件（如果未定义配置，则插件使用默认值）：

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <configuration>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </build>
  ...
</project>

并执行以下任何命令：

mvn javadoc:javadoc
mvn javadoc:jar
mvn javadoc:aggregate
mvn javadoc:aggregate-jar
mvn javadoc:test-javadoc
mvn javadoc:test-jar
mvn javadoc:test-aggregate
mvn javadoc:test-aggregate-jar

对于所有jar目标，首先生成 javadocs，然后将其打包到 jar 文件中。

Javadoc 配置

Javadoc 插件支持大量的配置参数。每个配置参数都会变成一个标签名称。

有关这些参数的列表，请参阅Javadoc 插件文档。这些参数中的大多数都直接传递给 Javadoc 工具本身。

重要说明：在pom中的 <reporting/> 或 <build/> 元素中配置 Javadoc 插件的行为与配置插件指南中描述的行为不同。

例如，如果您有以下代码段：

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <configuration>
          <show>private</show>
          <nohelp>true</nohelp>
        </configuration>
      </plugin>
    </plugins>
  </build>

  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.3.2</version>
        <configuration>
          <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile>
          <show>public</show>
        </configuration>
      </plugin>
    </plugins>
  </reporting>
</project>
mvn网站
它将使用给定的样式表（在 <reporting/> 中定义）和帮助页面（nohelp的默认值为true）为公共成员（在 <reporting/> 中定义）生成 Javadoc。
mvn javadoc:javadoc
它将使用样式表（在 <reporting/> 中定义）为私有成员（在 <build/> 中定义）生成 Javadoc，并且没有帮助页面（在 <build/> 中定义）。