Question

我正在使用Ant，并且希望为所有包，源等启用checkstyle。理想情况下，它就像在我现有的构建目标上添加对checkstyle的依赖一样简单，但由于违规而破坏了构建。我不想使用评论样式禁用，因为这意味着对源文件的更改。

我想要做的禁用是一种特定类型的检查（例如，由于现有代码库中有数百万条违规行而拖尾空白）

有没有办法配置checkstyle来做到这一点？

Answer 1

您可以通过在运行Checkstyle Ant task时指定的Checkstyle配置文件中添加或删除检查来启用和禁用检查。 Checkstyle完全运行配置XML中的检查（例如Sun Checks）。

不可以禁用配置中存在的检查：

<module name="EmptyBlock">
    <property name="enabled" value="false" />   <!-- won't work -->
</module>

也无法告诉Checkstyle运行“除 EmptyBlock 之外的所有检查”，因为没有“所有检查” - 可用检查集完全取决于配置XML 。但是，它可能是Checkstyle工具的一个很好的补充，以支持如上所示的禁用检查，因为这将使不使用配置GUI的人的生活更轻松。

如果您不希望Checkstyle违规导致构建失败，请将Checkstyle Ant任务的failOnViolation参数设置为false。您还可以使用maxWarnings和maxErrors参数来设置在构建应该中断之前容许多少警告或错误的阈值。

哪些违规被视为错误，哪些警告取决于您指定的Checkstyle配置中的单个检查的severity属性（docs）。默认严重性为“警告”。