Question

在我正在进行的项目中，由于缺少对私有成员变量的Javadoc评论，checkstyle失败并显示“缺少Javadoc评论”。这对我来说似乎是不必要的严格行为，我想使用抑制XML文件来抑制私有成员的错误。

以下文件成功抑制变量上的所有 checkstyle Javadoc错误：

<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <suppress files=".*" checks="JavadocVariable"/>
</suppressions>

但是，这并不是非常有用的行为，因为我仍然认为未将受保护和公共成员记录为错误。

如何修改checks属性以便为我提供有限的抑制？

Answer 1

Afaik，除非你想要注释每个私有字段，否则无法使用抑制来实现。相反，请配置JavadocVariable检查，使其不包含私有范围：

<module name="JavadocVariable">
   <property name="scope" value="package"/>
</module>

package package表示“[1,2,12] [1,3,11] [1,4,10] [1,5,9] [1,6,8] [1,7,7] = EXAMPLE OF WRONG OUTPUT, NO REPEATING NUMBERS WITHIN COMBINATION [1,8,6] = EXAMPLE OF WRONG OUTPUT, NO REPEATING NUMBERS IN OTHER SOLUTIONS (see [1,6,8]) [2,3,10] [2,4,9] [2,5,8] [2,6,7] [3,4,8] [3,5,7] [4,5,6]或更多公开”。

抑制suppressions.xml中PRIVATE成员变量的checkstyle错误？

1 个答案: