目次 Checkstyle概要 CheckstyleとIDEの統合 Checkstyle標準のチェック項目のカテゴリー Checkstyleとビルドツールの統合 Checkstyle標準のチェック項目のカテゴリー 標準で配布されているコーディング規約 オープンソースプロジェクトとCheckstyle ElasticSearchプロジェクトでのCheckstyleの利用 まとめ Checkstyle概要 Checkstyleは、プログラマーがコーディング規約に則ったJavaコードを書くのを補助する開発ツールです。 以下は、Checkstyleのサイトからの、日本語訳した引用になります。 （Checkstyleは）コーディング規約のチェックという大切ではあるけれども退屈なタスクを自動化し、プログラマーの貴重な時間を節約します。 プロジェクトで定められたコーディング規約を確実に守りつつ、プロジェクトを進めるための非常に有用なツールです。 また、Checkstyleは、クラス設計やメソッド設計の問題を発見や、コードのレイアウト・フォーマットのチェックなどの、ソースコードの様々な側面を検査を行うことができます。 こうしたチェックの種類や詳細は、前述のChecksytleサイトのChecksをご覧ください。 Checkstyleのチェック項目は、豊富な設定パラメータでカスタマイズすることができるため、すでにコーディング規約がある場合でも、 概ねその規約に適合するルールを記述できます。 またプロジェクトのコーディング規約がまだない場合は、「Sun Javaコーディング規約」や、「Google Java Style」等の 広く利用されているコーディング規約のチェックを行う設定ファイルがあらかじめ用意されているので、 それらを使用することでコーディング規約をプロジェクトのプロセスに簡単に組み込むことができます。 Checkstyleでは、XMLファイルを使用してルールを記述します。 記述したルールに基づくチェックは、Checkstyle標準ではjavaコマンド及びantタスクで提供されていますが、 実プロジェクトで利用する場合は、IDEへの組み込み、及びビルドツールへの組み込みで使用することが一般的です。 IDEへの組み込みでは、各種IDE向けのプラグインが提供されているので、それらを利用することでプログラマは ソースコードを書きながらリアルタイムにチェックを行うことができます。…