如何抑制 CheckStyle 中的警告？ [复制]

Question

我正在为 Eclipse 使用 CheckStyle 插件。

在 99% 的情况下，我很擅长发现我不打算做的事情，但实际上有 1% 的时间我确实打算故意违反规则，我想让 CheckStyle 知道它不需要关注标记警告。

示例：缺少 Javadoc 注释规则。大多数时候，我希望在我的方法上使用 Javadoc cmets。但是，一个方法如：

public boolean isValid() {
  return valid;
}

可能没有人也可以。

有没有类似@SuppressWarnings 注释的东西可以用来将特定的CheckStyle 规则违规标记为可接受？也许是某种特殊格式的评论？我不想禁用规则，我只想忽略特定违规行为。

（我意识到在这种情况下我可以只写 Javadoc 注释，但在其他情况下修复规则违规并不是那么简单）。

Answer 1

看起来很乏味，但需要明确的 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>

Answer 2

Synthesis 指向 Checkstyle 配置页面。略读了一下，我发现SuppressWithNearbyCommentFilter 看起来很有希望，除非我误解了它的用途......

Answer 3

PhiLho 是对的 - SuppressWithNearbyCommentFilter 或 SuppressionCommentFilter 可以提供帮助。我配置了 SuppressionCommentFilter 并添加 cmets "CHECKSTYLE:OFF" 和 "CHECKSTYLE:ON" 将暂时禁用检查样式。