如何查找失败的checkstyle规则的名称

Question

Checkstyle对某些代码感到厌烦，我想添加一个抑制规则。如何查找失败规则的名称，以便我可以明确地为此部分代码禁止该规则？

Answer 1

如果您使用的是Checkstyle的命令行版本，最简单的方法是查看XML输出报告。使用-f xml告诉Checkstyle输出XML。 XML中的违规消息如下所示：

<error line="0" severity="error" message="Missing package-info.java file."
    source="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck"/>

所以在这里，抑制过滤器使用的检查名称是JavadocPackage。

对于手动查找，您还有其他选择：

• 您可以手动转到the list of available checks并从违规邮件中搜索关键字。 （感谢@crasp在评论中指出这一点。）
• 如果您使用的是Eclipse，则可以按照here所述选中“包含违规消息中的规则名称”复选框，以查看Eclipse中的规则名称。
• 如果您使用的是SonarQube，则可以通过点击问题查看规则名称。