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

Question

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

以下文件成功抑制了变量上的所有 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>

但是，这不是非常有用的行为，因为我仍然认为未能记录 protected 和公共(public)成员是一个错误。

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

Answer 1

Afaik，这无法使用抑制来实现，除非您想注释每个私有(private)字段。相反，配置 JavadocVariable检查以使其不覆盖私有(private)范围:

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

A scope package 的意思是“package 或更多公共(public)”。