使用具有合理 doclint 参数的 maven JavaDoc

Question

有很多关于如何在 Java 中关闭 JavaDoc lint 功能的信息。信不信由你，今天我决定使用这个功能并修复我的 Java文档。然而，在其标准配置中，它抱怨每个可能丢失的 @param 和 @return。根据我在 Java 8 javadoc technotes 的 JavaDoc 文档中看到的内容，我的选择是 -Xdoclint:all,-missing。这应该包括所有检查，但不包括对错过文档机会的投诉。 Maven 配置如下：

  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.4</version>
        <configuration>
          <additionalparam>-Xdoclint:all,-missing</additionalparam>
          <aggregate>false</aggregate>
        </configuration>
        <reportSets>
          <reportSet>
            <id>default</id>
            <reports>
              <report>javadoc</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
    </plugins>
  </reporting>

但是当运行 mvn site 我得到错误：

[ERROR] Exit code: 1 - javadoc: error - invalid flag: -missing

我怀疑是 maven 中的参数处理问题，但是，引用没有帮助。

知道如何使用它吗？以合理的方式检查 JavaDoc 的任何替代良好做法？

Answer 1

正确的语法是：

-Xdoclint:all -Xdoclint:-missing

Answer 2

您期望的语法 (-Xdoclint:all,-missing) 是正确的。它将与本机命令行 javadoc 工具一起正常工作。不幸的是，如果使用逗号，Maven JavaDoc 插件似乎会将一个附加参数拆分为多个参数。此错误记录在 MJAVADOC-368.

中

为避免出现问题，请使用@hasnae 回答 (-Xdoclint:all -Xdoclint:-missing) 中描述的更冗长的语法。

使用具有合理 doclint 参数的 maven JavaDoc

Use maven JavaDoc with reasonable doclint parameters

java

javadoc

maven

maven-javadoc-plugin