チェックスタイル

チェックスタイル

安定リリース	10.17.0 / 2024年5月26日; 5か月前 (2024-05-26)
リポジトリ	github.com/checkstyle/checkstyle
書かれた	ジャワ
オペレーティング·システム	クロスプラットフォーム
タイプ	静的コード分析
ライセンス	GNU 劣等一般公衆利用許諾書
Webサイト	チェックスタイル

Checkstyle ^[1]は、 Javaソースコードが指定されたコーディングルールに準拠しているかどうかを確認するためにソフトウェア開発で使用される静的コード解析ツールです。

このプロジェクトはもともと 2001 年に Oliver Burn 氏によって開発され、現在は世界中の開発者チームによって維持されています。

現在の安定版リリースはバージョン10.17.0 ^[2]で、Javaバージョン11から17をサポートしています。^[3]

ソフトウェア開発プロジェクトで採用されるプログラミングスタイルは、コードが適切なプログラミング プラクティスに準拠していることを保証するのに役立ちます。これにより、コードの品質、可読性、再利用性が向上し、開発コストが削減される可能性があります。Checkstyle によって実行されるチェックは、主にコードの表示に限定されます。これらのチェックでは、コードの正確性や完全性は確認されません。Checkstyle ルールはプログラミング スタイルではなく、単にコードをフォーマットするためのルールです。

Checkstyle は利用可能なモジュールのセットを定義し、各モジュールは設定可能な厳密さのレベル (必須、オプションなど) でルール チェックを提供します。各ルールは通知、警告、およびエラーを発生させることができます。たとえば、Checkstyle は次の項目を検査できます。

• クラス、属性、メソッドのJavadocコメント。
• 属性とメソッドの命名規則。
• 関数パラメータの数。
• 行の長さ;
• 必須ヘッダーの存在。
• インポートとスコープ修飾子の使用。
• いくつかの文字間のスペース;
• 階級構築の実践。
• 複数の複雑さの測定。

Checkstyle は、Java VM内で実行できるJAR ファイルとして、またはApache Antタスクとして利用できます。また、 IDEやその他のツールに統合することもできます。

• 静的コード解析ツールの一覧
• EclipseCS - Checkstyle 用の Eclipse プラグイン。
• Checkstyle-IDEA - IntelliJ IDEA および Android Studio 用の Checkstyle プラグイン
• SevNTU-Checkstyle は、Wayback Machineで 2013-03-22 にアーカイブされています- checkstyle アップストリームの一部ではないチェックの数を含む EclipseCS の拡張機能です。
• Checkstyle アドオン - 追加の Checkstyle チェック
• Checkstyle for PHP - Checkstyle の PHP バージョン

• 公式サイト
• GitHubの checkstyle