web-dev-qa-db-ja.com

CheckStyleで警告を抑制するにはどうすればよいですか？

Eclipse用のCheckStyleプラグインを使用しています。

99％の確率で意図していなかったものを見つけるのは得意ですが、実際に1％の確率でルールに違反することを意図していたので、CheckStyleに警告のフラグ付けに関係する必要がないことを知らせたいと思います。

例：Javadocコメントルールがありません。ほとんどの場合、メソッドに関するJavadocコメントが必要です。ただし、次のような方法：

public boolean isValid() {
  return valid;
}

おそらく1つなしで通り抜けることができます。

特定のCheckStyleルール違反を許容可能としてフラグを立てるために使用できる@SuppressWarningsアノテーションのようなものはありますか？ある種の特別にフォーマットされたコメント、多分？ルールを無効にしたくありません。特定の違反を無視したいだけです。

（この場合、Javadocコメントを書くことができますが、他の場合、ルール違反の修正はそれほど簡単ではありません）。

javaeclipsecheckstyle
15
Tom Tresansky

かなり退屈なようですが、それを無視するには明示的な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>
2
Synthesis

PhiLhoは正しいです-SuppressWithNearbyCommentFilterまたはSuppressionCommentFilterが役立ちます。 SuppressionCommentFilterを構成し、コメント「CHECKSTYLE：OFF」と「CHECKSTYLE：ON」を追加すると、チェックスタイルが一時的に無効になります。

6
Aaron

合成は、Checkstyle構成ページを指していました。それをざっと見たところ、その目的を誤解しない限り、有望と思われるSuppressWithNearbyCommentFilterが見つかりました...

2
PhiLho