Java的checkstyle，MagicNumberCheck

Question

我正在使用checkstyle获取关于我的源代码的报告。这个问题是关于MagicNumberCheck的。

我正在使用Date/（org.joda.）DateTime在我的源代码中如下所示：

DateTime dateTime = new DateTime(2013, 2, 27, 23, 0):
dateTime.plusHours(57);

如果魔法数字在某个日期或日期时间内，有没有办法抑制MagicNumberCheck通知？




Answer 1

您可以使用注释来抑制CheckStyle通知

//CHECKSTYLE:OFF

在那些台词和

//CHECKSTYLE:ON

之后重新启用它。

这需要启用模块SuppressionCommentFilter。

当然，您也可以创建自己的模块，它完全按照您的要求工作。

Answer 2

可以使用SuppressionCommentFilter检查来执行此操作。

配置属性值，如（在checkstyle配置文件中）

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

现在，对于所需的行，您可以这样做

//Check:OFF: MagicNumber
DateTime dateTime = new DateTime(2013, 2, 27, 23, 0):
dateTime.plusHours(57);
//Check:ON: MagicNumber

这只会抑制MagicNumber检查，其余检查将在此处工作。

你也可以取消多重检查，比如

//Check:OFF: MagicNumber|Indentation
Code Here
//Check:ON: MagicNumber|Indentation

这将仅禁止MagicNumber和缩进检查。其他检查会正常工作。