Question

有很多关于如何在Java 8中关闭神圣的JavaDoc lint功能的信息。信不信由你，今天我决定使用这个功能并修复我的JavaDocs。但是，在其标准配置中，它抱怨每个可能缺少的@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 answer（-Xdoclint:all -Xdoclint:-missing）中描述的更详细的语法。

将maven JavaDoc与合理的doclint参数一起使用

2 个答案: