如何在 CheckStyle 中禁止显示警告?

2022-09-03 15:34:06

我正在使用Eclipse的CheckStyle插件。

在99%的时间里,它很擅长找到我不想要的东西,但是实际上有1%的时间我确实打算故意违反规则,我想让CheckStyle知道它不必担心标记警告。

示例:缺少 Javadoc 注释规则。大多数时候,我希望Javadoc对我的方法进行评论。但是,像这样的方法:

public boolean isValid() {
  return valid;
}

可能没有一个可以过得去。

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

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


答案 1

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


答案 2

看起来很乏味,但需要有明确的XML配置才能忽略它。你可能会找到一个GUI来通过使用Eclipse或Netbeans的Checkstyle插件来做到这一点。我找到的示例位于 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>

推荐