在 checkstye.xml 中禁用缺少的 javadoc 注释

Question

我正在尝试禁用 Maven 项目中 checkstyle.xml 中的 "missing javadoc comments" 错误。我尝试添加以下模块，但没有成功：

<!-- No need for Javadoc -->
    <module name="JavadocType">
        <property name="severity" value="ignore"/>
    </module>
    <module name="JavadocMethod">
        <property name="severity" value="ignore"/>
    </module>
    <module name="JavadocVariable">
        <property name="severity" value="ignore"/>
    </module>

是否有任何我可以添加的特定模块来禁用所有 javadoc 注释检查或我可以对 Maven 依赖项进行的任何类型的更改？

Answer 1

显然，Checkstyle 版本和 Maven Checkstyle 插件存在一些不匹配。有一种方法可以解决 Checkstyle 的问题：提供 Checkstyle 最新版本的 MVN 插件（目前为 8.5）：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>2.17</version>
    <dependencies>
        <dependency>
            <groupId>com.puppycrawl.tools</groupId>
            <artifactId>checkstyle</artifactId>
            <version>8.5</version>
        </dependency>
    </dependencies>
</plugin>

如您所见，它使用了旧版本的 Checkstyle。但是，您还需要在 IDE 中使用较旧的插件。

在 checkstye.xml 中禁用缺少的 javadoc 注释

Disable missing javadoc comments in checkstye.xml

java

checkstyle

maven-checkstyle-plugin