java checkstyle 导入_java-如何在Checkstyle中禁止对文件的所有检查？

java-如何在Checkstyle中禁止对文件的所有检查？

我正在对第三方类进行覆盖，并且想取消对此类的所有检查(因为我只保留它直到接受补丁为止)。

有没有办法禁止对文件的所有检查？

我尝试使用“ *”，但是失败了。

Alceu Costa asked 2019-11-16T18:07:46Z

7个解决方案

59 votes

不知道您是使用命令行还是在IDE中，但是基本上您将需要一个suppresions文件。 如果您要手动编辑Checkstyle配置文件，请向其中添加一个新模块：

您的files可能是这样的：

/p>

"-//Puppy Crawl//DTD Suppressions 1.1//EN"

"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

“ files”属性的值基本上是源文件的正则表达式，而“ checks”属性的值则是要跳过哪些检查的正则表达式(“ [a-zA-Z0-9]*”基本上意味着跳过所有内容)。 我猜这是您要寻找的模式吗？

aberrant80 answered 2019-11-16T18:08:22Z

24 votes

通过在我的checks.xml中添加SuppressionCommentFilter标记，我可以取消文件中的检查：

首先，我将FileContentHolder标记添加为TreeWalker标记的子标记(从com.puppycrawlwl.tools:checkstyle版本8.1开始不需要此步骤)：

...

...

然后，我在checks.xml中添加了SuppressionCommentFilter(从com.puppycrawl.tools:checkstyle版本8.1开始-在“ TreeWalker”节点下)：

在每个我想取消检查的文件中，我在文件的第一行中插入了以下注释：

// CHECKSTYLE:OFF

Alceu Costa answered 2019-11-16T18:09:06Z

17 votes

aberrant80的回答很有帮助。 借助他的提示-使用正则表达式模式匹配，我还可以通过将整个程序包添加到checkstyle-suppressions.xml文件中来取消整个包的checkstyle。例如。 跳过对jaxb包下所有自动生成的Java文件的checkstyle检查，

Inxsible answered 2019-11-16T18:09:33Z

7 votes

如果您将Checkclipse Eclipse插件用于Checkstyle，则可以通过转到项目属性下的Checkclipse> File Filter选项卡来包含或排除文件模式(包括目录)。 例如，我的项目在顶层包含src和test目录。 我希望Checkstyle仅应用于src目录中的文件(省略测试)，因此我添加了一个包含模式，如下所示：

src/.+java$

如您所见，它使用正则表达式样式的语法进行模式指定。

Rob H answered 2019-11-16T18:10:04Z

2 votes

@ aberrant80的答案很有启发性，尽管在我的项目中不起作用。 为了抑制checkstyle在Foo.java中寻找的任何警告，根据链接，如果使用了maven：

org.apache.maven.plugins

maven-checkstyle-plugin

...

...

checkstyle.xml

checkstyle-suppressions.xml

...

...

并在checkstyle-suppressions.xml中

到目前为止，最高版本是1.1(不存在1.2)。

Tiina answered 2019-11-16T18:10:43Z

0 votes

有一个选项可以忽略写保护的文件。 或包装中的文件。

akarnokd answered 2019-11-16T18:11:07Z

0 votes

如果您不想检查项目中的一组文件，则可以过滤掉这些文件，以免通过创建文件过滤器来检查它们

文件过滤器使用正则表达式来确定要排除的文件。 正则表达式使用完整的文件名-因此，您还可以排除整个文件夹。 在这种情况下，您可以根据需要排除整个包装。

如果您四处搜索-您可能会发现一些Checkstyle配置属性文件，其中包含您要查找的示例。 我建议您这样做之后-将其另存为模板，以便将来使用

PSU_Kardi answered 2019-11-16T18:11:45Z