Question

有人知道为什么CheckStyle不会在 Interface 方法上仅在实际实现方法上标记缺少的JavaDoc吗？

假设我有以下内容，

<module name="JavadocMethod">
    <property name="scope" value="public"/>
    <property name="allowMissingParamTags" value="true"/>
    <property name="allowMissingThrowsTags" value="true"/>
    <property name="allowMissingReturnTag" value="true"/>
    <property name="minLineCount" value="2"/>
    <property name="allowedAnnotations" value="Override, Test"/>
    <property name="allowThrowsTagsForSubclasses" value="true"/>

这将报告实际的类方法中缺少JavaDoc的信息，但不会报告接口方法中的JavaDoc。

也尝试添加它，但是没有用：

<property name="tokens" value="INTERFACE_DEF"/>
<property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>

我从中得到的类似线程（但不起作用）：checkstyle JavadocType only on interfaces

是否可以强制对接口方法进行JavadocMethod检查？

原因： Spring Data （JPA库）基于仅接口的方法名称，其中基于@Query批注配置程序在幕后提供实现。因此，我们没有自己的实现。因此，在这种情况下，我们需要检查并要求在接口方法上使用JavaDoc。

Answer 1

<property name="minLineCount" value="2"/>

这就是为什么。如果行数为2或更大，则指定需要一个javadoc。接口没有任何行数，所以这就是为什么您没有任何违规的原因。

$ cat TestClass.java
public interface TestInterface {
    void method();
}

$ 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="JavadocMethod">
    <property name="scope" value="public"/>
    <property name="allowMissingParamTags" value="true"/>
    <property name="allowMissingThrowsTags" value="true"/>
    <property name="allowMissingReturnTag" value="true"/>
    <property name="allowedAnnotations" value="Override, Test"/>
    <property name="allowThrowsTagsForSubclasses" value="true"/>
</module>
    </module>
</module>

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

CheckStyle不会在接口方法上标记缺少的JavaDoc

1 个答案: