checkstyle - Java checkstyle，魔数(Magic Number)检查

Question

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

我正在使用 Date/(org.joda.)DateTime在我的源代码中是这样的:

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

如果魔数(Magic Number)在 Date 或 DateTime 内，有没有办法抑制 MagicNumberCheck 通知？

Answer 1

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

配置属性值，如(在您的 checkstyle configuration 文件中)

<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 checks ，其余检查将在这里工作。

您也可以禁止多次检查，例如

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

这只会抑制 MagicNumber and Indentation Checks .其他检查将正常工作。