3

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

4

1 回答 1

2

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

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

范围意味着“或更多公共” package。package

于 2015-04-27T19:26:37.060 回答