如何禁用类的Checkstyle JavaDoc验证？

Question

我在Java项目中使用checkstyle 2.17。 我想对所有类都忽略javadoc，而只想对接口强制使用javadoc。 有什么办法可以在xml配置文件中做到这一点。 现在看起来像这样：

<!-- Javadoc for interface must be present/valid. The same for classes is optional-->
<module name="JavadocType">
        <property name="tokens" value="INTERFACE_DEF"/>
</module>

它在接口上工作正常，但是在没有为类指定javadoc时给出错误。

Answer 1

您的配置正确。 Checkstyle甚至进行了一项测试 ，确认如果将tokens设置为INTERFACE_DEF ，则不会报告类的任何违规情况。

Answer 2

我尚未对其进行测试，但是尝试覆盖XML中的acceptableTokens而不是tokens 。

这就是我们防止在类构造函数上强制执行Javadoc规则的方式。 不要忘记从*_checks.xml文件中引用新的自定义类。

public class JavadocMethodCheck extends com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck {

    @Override
    public int[] getAcceptableTokens() {
        return Arrays.stream(super.getAcceptableTokens())
            .filter(t -> t != TokenTypes.CTOR_DEF) // Don't enforce javadoc comments on constructors
            .toArray();
    }
}