java - 使用 Maven 自动验证 JavaDoc

Question

在重构过程中，JavaDoc 经常会过时。它描述了不再存在或缺少一些新参数的方法参数，以举例说明。

如果有一个 Maven 插件可以自动检查现有的 JavaDoc 并在存在某种“JavaDoc 违规”时停止构建，那就没问题了。我见过 Maven-JavaDoc-Plugin 和 maven-doccheck，但两者似乎都只能在出现违规时自动修复现有的 JavaDoc，而不是放弃一些错误或警告。

有谁知道如果有这样的 Maven 插件以及如何归档它？

Answer 1

据我所知，目前使用 maven-javadoc-plugin 是不可能的。JavaDoc 插件有javadoc:fix mojo，但这会自动修复问题。

我最近为这个问题创建了一个 JIRA 条目：MJAVADOC-374（它实际上是MJAVADOC-314的副本）。

更新：您可以使用Checkstyle来验证正确的 JavaDoc。此处描述了配置选项。使用maven-checkstyle-plugin和check-Mojo将其集成到您的 Maven 构建中。

一个示例 Maven 配置可能如下所示：

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.15</version>
        <configuration>
          <logViolationsToConsole>true</logViolationsToConsole>
          <checkstyleRules>
            <module name="JavadocMethod">
              <property name="scope" value="public"/>
              <property name="allowUndeclaredRTE" value="true"/>
              <property name="allowMissingParamTags" value="false"/>
            </module>
          </checkstyleRules>
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>