如何仅针对特定规则抑制代码块中的检查样式检查?

时间:2010-04-14 18:44:52

标签: checkstyle suppression

  

可能重复:
  How to disable a particular checkstyle rule for a particular line of code?

在为一段代码关闭Checkstyle时,是否存在仅抑制特定检查的语法。

所以而不仅仅是

// CHECKSTYLE:OFF
代码
// CHECKSTYLE:ON

你可以拥有像

这样的东西

// CHECKSTYLE:OFF:RequireThis,
代码
// CHECKSTYLE:ON

如果我们故意对样式进行例外处理,那么更清楚的是例外情况会更清楚。

1 个答案:

答案 0 :(得分:8)

建议阅读SuppressionCommentFilter上的文档(它埋没在位),以获取大量示例。

如何配置过滤器的示例是:

<module name="SuppressionCommentFilter">
    <property name="offCommentFormat" value="CSOFF\: ([\w\|]+)"/>
    <property name="onCommentFormat" value="CSON\: ([\w\|]+)"/>
    <property name="checkFormat" value="$1"/>
</module>

然后,您可以使用以下内容关闭代码块的RequireThis检查:

// CSOFF: RequireThis
... code
// CSON: RequireThis