使用合理的doclint参数与maven JavaDoc

Question

有很多关于如何在Java 8中关闭JavaDoc lint功能的信息。信不信由你，今天我决定使用这个功能并修复我的JavaDocs。然而，在其标准配置中，它会抱怨每一个可能缺失的@param和@return。从我在Java 8 javadoc technotes文档中看到的内容来看，我选择的选项是-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吗？

- cruftex

---

"-Xdoclint: all, -missing" 可能是，但如果是的话，就会被提到。 - Joop Eggen

Answer 1

正确的语法是：

-Xdoclint:all -Xdoclint:-missing 

- hasnae

Answer 2

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

为了避免您的问题，请使用更详细的语法，如 @hasnae 的答案所述 (-Xdoclint:all -Xdoclint:-missing)。

- FrVaBe