如何为特定代码行禁用特定的checkstyle规则?

时间:2011-06-20 10:59:19

标签: java checkstyle

是的,我看到了这个问题:

How to disable a particular checkstyle rule for a particular line of code?

但是我无法发表评论,我想问是否可以做OP所要求的事情:

如何为一行代码

禁用一个特定规则

我也看到了这个: Is there a way to force Checkstyle to ignore particular warning in the source code?

我想我的问题的答案是使用 SuppressWithNearbyCommentFilter

我只是不明白我在java中的评论应该是什么样的。

说我有以下代码:

public class MyDataContainer {
  /** the name */
  public String name;
}

我希望摆脱“可见性修饰符”警告,警告。

我需要启用什么(使用eclipse--cs.sf.net插件)?

我的评论如何看待?

我设法启用了Suppresion Comment Filter并用

包围了我的整个班级
//CHECKSTYLE:OFF
//CHECKSTYLE:ON

但我真的不喜欢这个解决方案。

1 个答案:

答案 0 :(得分:11)

有点晚,以备将来参考:

你可以这样使用SuppressWithNearbyCommentFilter:

<module name="SuppressWithNearbyCommentFilter">
   <property name="commentFormat" value="CHECKSTYLE DISABLE ([\w\|]+) FOR (-?\d+) LINES"/>
   <property name="checkFormat" value="$1"/>
   <property name="influenceFormat" value="$2"/>
</module>

在您要禁用警告的行上,您可以写:

// CHECKSTYLE DISABLE <WarningName> FOR <# of lines> LINES

例如

// CHECKSTYLE DISABLE MagicNumber FOR 2 LINES

该数字也可以为负数(如果警告是在某些您无法触及的自动生成的代码中)。