「IntelliJ IDEA で CheckStyle を使うには」の版間の差分

提供: tknotebook
移動: 案内検索
(ページの作成:「Javaソフトの開発で checkstyle によるチェックを義務づけられることも多いと思います。 この記事では IntteliJ IDEA での checkstyle ...」)
 
 
(1人の利用者による、間の10版が非表示)
1行: 1行:
Javaソフトの開発で checkstyle によるチェックを義務づけられることも多いと思います。
+
[[Category:コンピュータ]][[Category:IDE]][[Category:IntelliJ IDEA]]
 +
[[メインページ]]>[[コンピュータの部屋#ソフトウェア]]>[[IntelliJ IDEA Tips]]
  
この記事では IntteliJ IDEA での checkstyle の使い方を説明します。
+
 
 +
この記事では Javaではおなじみのcheckstyle の、 IntteliJ IDEA での使い方を 説明します。
  
 
とても簡単です(^^;
 
とても簡単です(^^;
 +
 +
==checkstyleとは==
 +
 +
いわゆる Javaのコーディング規約のチェックルールです。コメントの書き方とか、変数名の命名とか
 +
様々な規則にソースコードが違反していないかチェックしてくれます。EclipseもIntelliJ IDEA も
 +
プラグインが準リアルタイムにソースをチェックするので、規則違反がコードを書いている最中に
 +
わかりとても便利です。
 +
 +
昨今は納品時に checkstyle で警告なしが義務づけられたりするので、ないと困るツールです。
  
 
==プラグインのインストール==
 
==プラグインのインストール==
10行: 21行:
  
 
[File]→[Settings] のダイアログで  [plugins] を選び CheckStyle-IDEA というプラグインを入れれば
 
[File]→[Settings] のダイアログで  [plugins] を選び CheckStyle-IDEA というプラグインを入れれば
準備完了です。
+
checkstyle が利用可能になります。
 +
 
 +
[[ファイル:Checkstype plugin.png]]
 +
 
 +
 
 +
 
 +
==checkstyle の設定==
 +
 
 +
既定でルール sun_check が入ってますが、恐ろしく厳しいので普通にコーディングすると
 +
警告だらけになってしまいます。
 +
 
 +
独自ルールを使うにはルールを記述した xml ファイルが必要です。ファイルがあれば下記の画面で読み込んで
 +
選択すれば、そのルールでチェックしてくれます。
 +
 
 +
 
 +
[[ファイル:Check stype 設定画面.png]]
 +
 
 +
 
 +
私はほどほどに厳しい下記のルールを使っています。
 +
ブラウザで右クリックして【ダウンロード】等を選び、xml ファイルとして保存すればルールファイルとして使えます。
 +
 
 +
【[[メディア:Checkstyle tknakamuri独自.xml]]】
 +
 
 +
尚、今回紹介したプラグインはルールの指定しかできません。Eclipse のように checkstyle のルール編集を
 +
GUI でできるようにするエディタを積んだプラグインは未発見です。
  
[[ファイル:Checkstyle tknakamuri独自.xml]]
+
ルールを独自に GUI で編集したい人は、そういうプラグインを探すか、Eclipse を使ってください。
 +
あしからず。

2016年12月31日 (土) 07:40時点における最新版

メインページ>コンピュータの部屋#ソフトウェア>IntelliJ IDEA Tips


この記事では Javaではおなじみのcheckstyle の、 IntteliJ IDEA での使い方を 説明します。

とても簡単です(^^;

checkstyleとは

いわゆる Javaのコーディング規約のチェックルールです。コメントの書き方とか、変数名の命名とか 様々な規則にソースコードが違反していないかチェックしてくれます。EclipseもIntelliJ IDEA も プラグインが準リアルタイムにソースをチェックするので、規則違反がコードを書いている最中に わかりとても便利です。

昨今は納品時に checkstyle で警告なしが義務づけられたりするので、ないと困るツールです。

プラグインのインストール

IntelliJ IDEA も他の IDE(開発環境)と同様 checkstyle の実行にはプラグインが必要です。

[File]→[Settings] のダイアログで [plugins] を選び CheckStyle-IDEA というプラグインを入れれば checkstyle が利用可能になります。

Checkstype plugin.png


checkstyle の設定

既定でルール sun_check が入ってますが、恐ろしく厳しいので普通にコーディングすると 警告だらけになってしまいます。

独自ルールを使うにはルールを記述した xml ファイルが必要です。ファイルがあれば下記の画面で読み込んで 選択すれば、そのルールでチェックしてくれます。


Check stype 設定画面.png


私はほどほどに厳しい下記のルールを使っています。 ブラウザで右クリックして【ダウンロード】等を選び、xml ファイルとして保存すればルールファイルとして使えます。

メディア:Checkstyle tknakamuri独自.xml

尚、今回紹介したプラグインはルールの指定しかできません。Eclipse のように checkstyle のルール編集を GUI でできるようにするエディタを積んだプラグインは未発見です。

ルールを独自に GUI で編集したい人は、そういうプラグインを探すか、Eclipse を使ってください。 あしからず。