Tbpgr Blog

元エンジニア 人事 tbpgr(てぃーびー) のブログ

CheckStyle | CheckStyleでコメントによる単一行チェック除外設定を行う方法について

パンくず

Eclipse
CheckStyle
CheckStyleでコメントによる単一行チェック除外設定を行う方法について

概要

CheckStyleでコメントによる単一行チェック除外設定を行う方法について

詳細

基本はチェック内容を守りたいが、一部チェック適用外にしたい場合などに
該当行に任意の形式でコメントをすることで除外するための設定が可能です。

設定

・メニューのウインドウ=>設定=>CheckStyleを選択
・構成を選択
・フィルターを選択
・Suppress With Nearby Comment Filterの追加を選択
・commentFormatに任意の文字列を指定
ここでは参考として以下を設定

CHECK_IGNORE\(Reason:.+\)

.+部は正規表現。除外理由を記述することを想定したフォーマットです。

実用例

上記の設定後に下記のように記述すると該当行が検出対象外になります。

int second = 2; // CHECK_IGNORE(Reason:マジックナンバー対象外)

のように利用する。

補足

CHECK_IGNORE\(Reason:.+\)の部分はコードテンプレートとして登録して
プロジェクトメンバーに配布すると便利です。