在抑制.xml 中抑制 PRIVATE 成员变量的 checkstyle 错误？答案

【问题标题】：Suppress checkstyle errors on PRIVATE member variables in a suppressions.xml?在抑制.xml 中抑制 PRIVATE 成员变量的 checkstyle 错误？
【发布时间】：2015-07-06 09:28:55
【问题描述】：

在我正在处理的一个项目中，由于 private 成员变量上缺少 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 属性以提供我需要的有限抑制？

【问题讨论】：

标签： java javadoc checkstyle code-standards

【解决方案1】：

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

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

package 中的 scope 表示“package 或更多公开”。

【讨论】：