Javaのソースで見つけた CHECKSTYLE:OFF って何？から知るCheckstyle

ハイパー初心者でないとあまり疑問に思わないことです・・・Checkstyle知るキッカケとなったので。

はじまりは、CHECKSTYLE:OFFでした。

Javaのソースを見ていたらこんなのを見つけました。

//CHECKSTYLE:OFF
Javaのコード
//CHECKSTYLE:ON

なに？これ？がはじまりでした。

CHECKSTYLE:OFFはCheckstyleをOFFするものです。

「Java CHECKSTYLE:OFF」でぐぐってみると1件目からいい感じでした。

• 敢えて規約を破るケース（Checkstyleの警告抑制） - 都元ダイスケ IT-PRESS

ページに記載されているような記載が自分のプロジェクトにある checkstye.xml にもあった！

<module name="Checker">
  <property name="severity" value="warning"/>
  <module name="TreeWalker">
    <module name="FileContentsHolder"/>
    <module name="JavadocMethod">
 <省略>
  <module name="SuppressionCommentFilter"/>
  <module name="SuppressWithNearbyCommentFilter">
    <property name="commentFormat" value="CHECKSTYLE IGNORE THIS LINE"/>
  </module>
</module>

ということで「CHECKSTYLE:OFF」は・・・

コード内にコメントを書くことによってCheckstyleの警告を抑制できます。
<省略>
System.out.println(123); // CHECKSTYLE IGNORE THIS LINE
さらに、数行の範囲にわたって抑制したい場合は、以下のように書くこともできます。
// CHECKSTYLE:OFF
System.out.println(123);
System.out.println(456);
System.out.println(789);
// CHECKSTYLE:ON
敢えて規約を破るケース（Checkstyleの警告抑制） - 都元ダイスケ IT-PRESS

Checkstyleはコーディング規約をチェックするための静的解析ツールです。

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans of this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.
checkstyle – Checkstyle 8.1

プログラムの作成途中（Just In Time）でチェックが可能です。Eclipse上で実行する場合にはファイルの編集や追加のたびに、チェックが実行されます。これによりコードを書いた直後に誤りを修正できます。
Eclipseで使えるテストツールカタログ（2）：Eclipseで使える静的解析ツール - ＠IT

世の中にはコーディング規約がたくさんありますが、チェックに使うコーディング規約は自作もできるそうです。