Question

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

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

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

Answer 1

据我所知，maven-javadoc-plugin目前无法实现。

我最近为此问题创建了一个JIRA条目： ~~javadoc:fix~~ （实际上是MJAVADOC-374的副本）。

<强>更新：您可以使用MJAVADOC-314来验证正确的JavaDoc。配置选项为Checkstyle。使用described here和maven-checkstyle-plugin将其集成到您的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>

使用Maven自动验证JavaDoc

1 个答案: