java - 如何找到失败的 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 ，您可以通过单击问题来查看规则名称。