用法

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

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

要生成 javadocs 作为站点生成的一部分，您必须在 pom 的 <reporting> 部分中配置以下内容：

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

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

生成独立的 Javadocs

要为项目生成独立的 javadocs，您可以执行以下任何命令：

mvn javadoc:javadoc

要么

mvn javadoc:jar

对于mvn javadoc:jar ，首先生成 javadoc，然后将其打包到 jar 文件中。

Javadoc 配置

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

有关这些参数的列表，请参阅Javadoc 包摘要 。这些参数中的大多数都直接传递给 Javadoc 工具本身。