「特定の行の checkstyle のチェックを抑制するには」の版間の差分

2017年1月21日 (土) 14:54時点における版

Java のコーディングは基本は checkstyle のチェックに従うべきですが、たまにどうしてもチェックをオフにしたいことが有ります。

例えば JUNITの試験スーツの冒頭で

import static org.hamcrest.MatcherAssert.*;

と書けないとめんどくさいですが、checkstyle は容赦なく警告を出します。

このような場合、特定の行だけ checkstyle を抑止するコメントがあると便利ですが、既定ではありません。しかし作ることはできます。早速手順を示しましょう。

eclipse の [設定]→[checkstyle]の画面で現在利用している checkstyle を選びます。

上図のダイアログでは編集できるチェック構成を選んでください。ビルトイン構成は編集できませんから、お手持ちの構成か、ビルトイン構成を複製した構成を作ってから、チェック構成を選んでください。[構成...]ボタンを押すと編集できます。

上図のダイアログで、左のペインから[フィルター]→[Suppress With Nearby Comment Filper] を選びます。 [追加...]ボタンを押すと下図のダイアログが現れます。

上図の comment format という欄の

SUPPRESS CHECKSTYLE (\w+)

がソースに書くと chckstyle のチェックを抑制するコメントです。ただしこの場合

// SUPPRESS CHECKSTYLE XXX

と何を抑制するのかいちいち書かなくてはならないのでめんどくさいです。下図のように修正すればコメントを書いた行の checkstyle のチェックが無条件に抑止されます。

以下が使い方の例です。

import static org.hamcrest.MatcherAssert.*; // SUPPRESS CHECKSTYLE
import static org.hamcrest.Matchers.*; // SUPPRESS CHECKSTYLE

@@ 23行: / 23行: @@
 ビルトイン構成は編集できませんから、お手持ちの構成か、ビルトイン構成を複製した構成を
 作ってから、チェック構成を選んでください。[構成...]ボタンを押すと編集できます。
+==追加するモジュールを選択する==
 [[ファイル:特定の行のcheckstyleのチェックを抑制するには002.png]]
@@ 28行: / 30行: @@
 上図のダイアログで、左のペインから[フィルター]→[Suppress With Nearby Comment Filper] を選びます。
 [追加...]ボタンを押すと下図のダイアログが現れます。
+==追加するモジュールを編集する==
 [[ファイル:特定の行のcheckstyleのチェックを抑制するには003.png]]
@@ 39行: / 43行: @@
 [[ファイル:特定の行のcheckstyleのチェックを抑制するには004.png]]
+==使い方==
 以下が使い方の例です。