是否在suppressions.xml中抑制PRIVATE成员变量的检查样式错误

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或更多公共"。