我在我的项目中配置了一个Checkstyle验证规则,禁止定义具有超过3个输入参数的类方法。该规则适用于我的类,但有时我必须扩展第三方类,这些类不遵守这一特定规则。
是否有可能指示Checkstyle,某个方法应该被无声地忽略?
顺便说一句,我最终得到了我自己的Checkstyle包装器:qulice.com(参见Java代码质量的严格控制)
我在我的项目中配置了一个Checkstyle验证规则,禁止定义具有超过3个输入参数的类方法。该规则适用于我的类,但有时我必须扩展第三方类,这些类不遵守这一特定规则。
是否有可能指示Checkstyle,某个方法应该被无声地忽略?
顺便说一句,我最终得到了我自己的Checkstyle包装器:qulice.com(参见Java代码质量的严格控制)
当前回答
<module name="Checker">
<module name="SuppressionCommentFilter"/>
<module name="TreeWalker">
<module name="FileContentsHolder"/>
</module>
</module>
使用实例配置一个过滤器,在包含BEGIN GENERATED CODE的注释和包含END GENERATED CODE的注释之间屏蔽审计事件:
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="BEGIN GENERATED CODE"/>
<property name="onCommentFormat" value="END GENERATED CODE"/>
</module>
//BEGIN GENERATED CODE
@Override
public boolean equals(Object obj) { ... } // No violation events will be reported
@Override
public int hashCode() { ... } // No violation events will be reported
//END GENERATED CODE
查看更多
其他回答
<module name="Checker">
<module name="SuppressionCommentFilter"/>
<module name="TreeWalker">
<module name="FileContentsHolder"/>
</module>
</module>
使用实例配置一个过滤器,在包含BEGIN GENERATED CODE的注释和包含END GENERATED CODE的注释之间屏蔽审计事件:
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="BEGIN GENERATED CODE"/>
<property name="onCommentFormat" value="END GENERATED CODE"/>
</module>
//BEGIN GENERATED CODE
@Override
public boolean equals(Object obj) { ... } // No violation events will be reported
@Override
public int hashCode() { ... } // No violation events will be reported
//END GENERATED CODE
查看更多
每个引用SuppressWarningsFilter的答案都缺少一个重要的细节。如果在checkstyle-config.xml中定义了全小写的id,则只能使用它。如果不是,则必须使用原来的模块名称。
例如,如果在我的checkstyle-config.xml中有:
<module name="NoWhitespaceBefore"/>
我不能使用:
@SuppressWarnings({"nowhitespacebefore"})
然而,我必须使用:
@SuppressWarnings({"NoWhitespaceBefore"})
为了让第一个语法工作,checkstyle-config.xml应该有:
<module name="NoWhitespaceBefore">
<property name="id" value="nowhitespacebefore"/>
</module>
这对我来说是有效的,至少在CheckStyle 6.17版本中是这样。
如果你从qulice mvn插件(https://github.com/teamed/qulice)使用checkstyle,你可以使用以下抑制:
// @checkstyle <Rulename> (N lines)
... code with violation(s)
or
/**
* ...
* @checkstyle <Rulename> (N lines)
* ...
*/
... code with violation(s)
你也可以用这些特殊的注释来包围你想要禁用特定警告的代码:
// CHECKSTYLE:DISABLE:<CheckName>
<Your code goes here>
// CHECKSTYLE:ENABLE:<CheckName>
例:// CHECKSTYLE:DISABLE:ParameterNumberCheck
您可以在这里找到支持检查的完整列表(参见直接已知子类)。
我在回答上面的问题时遇到了困难,可能是因为我将checkStyle警告设置为错误。什么工作是SuppressionFilter: http://checkstyle.sourceforge.net/config_filters.html#SuppressionFilter
这样做的缺点是行范围存储在单独的suppression .xml文件中,因此不熟悉的开发人员可能不会立即建立连接。