代码之家 › 专栏 › 技术社区 › Tom Tresansky

如何抑制CheckStyle中的警告?[副本]

checkstyle eclipse java

Tom Tresansky · 技术社区 · 14 年前

我正在使用Eclipse的CheckStyle插件。

在99%的时间里,它很善于发现我无意中发现的东西,但在1%的时间里,我确实有意违反规则,我想让CheckStyle知道,它不必担心自己会发出警告。

示例:缺少Javadoc注释规则。大多数时候,我希望Javadoc对我的方法进行注释。但是,一种方法,例如:

public boolean isValid() {
  return valid;
}

有没有类似的东西 @SuppressWarnings 可用于将特定CheckStyle规则冲突标记为可接受的注释?可能是某种特殊格式的评论?我不想禁用规则,我只想忽略一个特定的违规行为。

(我意识到在这种情况下,我可以只编写Javadoc注释,但在其他情况下,修复规则冲突并不是那么简单)。

3 回复 | 直到 11 年前

Synthesis 14 年前

看起来很乏味,但是需要显式的XML配置来忽略它。通过使用Eclipse或Netbeans的Checkstyle插件,您可能可以找到一个GUI来实现这一点。我找到的例子在Checkstyle上 configuration

<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <suppress checks="JavadocStyleCheck"
              files="AbstractComplexityCheck.java"
              lines="82,108-122"/>
    <suppress checks="MagicNumberCheck"
              files="JavadocStyleCheck.java"
              lines="221"/>
</suppressions>

Aaron 13 年前

PhiLho是对的-SuppressWithNearbyCommentFilter或SuppressionCommentFilter可以提供帮助。我已经配置了SuppressionCommentFilter并添加了注释“CHECKSTYLE:关“和”CHECKSTYLE:开“将暂时禁用检查样式。

Armand 8 年前

SuppressWithNearbyCommentFilter 似乎很有希望,除非我误解了它的目的。。。

推荐文章

Endriu · 在Weblogic上运行Java应用程序

1 年前

Marco Osorio · 日食2022-03。更改目录路径用户设置Git配置

2 年前

Mosaed · 我可以将“GitHub桌面”中的vscode IDE更改为eclipse IDE吗

2 年前

Zoran Trifunovski · 无法在最新的Eclipse中使用OpenJDK 8运行ant任务

2 年前

newbie123 · 如何在Eclipse中向构建路径添加“项目和外部依赖项”选项?

2 年前

Paul DeWolf · EclipseJavaFX和Android

2 年前

sizzle · 即使param和DEFAUL_param是相同的,它们也不相等?

2 年前

nijeg52273 · RCP Oomph安装程序创建指南

2 年前

ThomasIsCoding · Eclipse:如何删除所有TODO标记的注释?

2 年前

Varsha · 如何对动态生成的树项执行单个选择?

2 年前