使用Maven自动验证JavaDoc

在重构期间,JavaDoc经常发生过时.它描述的方法参数不再存在,或者缺少一些新的参数,以举例说明.

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

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

解决方法:

据我所知,maven-javadoc-plugin目前无法实现. JavaDoc插件有javadoc:fix mojo,但这会自动修复问题.

我最近为这个问题创建了一个JIRA条目：MJAVADOC-374(实际上是MJAVADOC-314的副本).

更新：
您可以使用Checkstyle验证JavaDoc是否正确.配置选项为described here.使用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>

标签：java,maven,javadoc,maven-plugin,maven-javadoc-plugin
来源： https://codeday.me/bug/20190709/1408648.html