java - checkstyle JavadocType 仅在类/接口(interface)/枚举上

Question

我正在尝试配置 checkstyle 规则，它将验证类、接口(interface)和枚举，以使用以下配置强制 javadoc:

<module name="JavadocStyle">
    <property name = "checkEmptyJavadoc" value="true"/>
    <property name ="checkFirstSentence" value="false"/>
    <property name="tokens" value="CLASS_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF"/>

但它们正在得到反射(reflect)，即即使我没有在类级别提供任何 java 文档，检查样式​​仍然会通过，而不是给出有关缺少 java 文档的错误。

如有任何帮助，我们将不胜感激。

Answer 1

which will verify the classes, interfaces and enums to mandate the javadocs

首先，我建议您不要使用 JavadocStyle 来执行此操作，而应使用 MissingJavadocType，因为这是此检查的唯一目的。在未来的更新中，JavadocStyle 可能不再执行此操作，因为它重复了 MissingJavadocType 的操作。对于方法，请使用MissingJavadocMethod。

无论如何，对于您使用的任何一种检查，您都必须指定您希望它选取类的正确范围。如果不正确，则不会在所有情况下触发。

由于作用域不同，枚举违规但类违规的示例:

$ cat TestClass.java
public enum TestEnum {}
private class TestClass {}

$ cat TestConfig.xml
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">

<module name="Checker">
    <property name="charset" value="UTF-8"/>

    <module name="TreeWalker">
<module name="MissingJavadocType">
    <property name="scope" value="public"/>
    <property name="tokens" value="CLASS_DEF, ENUM_DEF, INTERFACE_DEF"/>
</module>
    </module>
</module>

$ java -jar checkstyle-8.32-all.jar -c TestConfig.xml TestClass.java
Starting audit...
[ERROR] TestClass.java:1: Missing a Javadoc comment. [MissingJavadocType]
Audit done.
Checkstyle ends with 1 errors.