15

我正在为 Eclipse 使用 CheckStyle 插件。

发现我 99% 的时间不打算做的事情非常棒，但实际上有 1% 的时间我确实打算故意违反规则，我想让 CheckStyle 知道它不需要关心标记警告。

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

public boolean isValid() {
  return valid;
}

可能没有人也能过得去。

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

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

4

3 回答 3

6

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

于 2011-08-04T05:08:10.170 回答
2

Synthesis 指向 Checkstyle 配置页面。略读它，我发现SuppressWithNearbyCommentFilter这似乎很有希望，除非我误解了它的目的......

于 2010-08-25T13:00:35.400 回答
2

看起来很乏味，但需要明确的 XML 配置才能忽略它。您可能可以通过使用适用于 Eclipse 或 Netbeans 的 Checkstyle 插件找到一个 GUI。我找到的示例在 Checkstyle配置页面上。

<?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>
于 2010-08-25T12:48:04.597 回答