その他の各種チェックを設定します。
テキスト中に出現する不適切な文字列をチェックします。
System.out.println や e.printStackTrace など、
文字列単位でチェックしたいパターンを指定しておきましょう。
不適切なパターンを正規表現で設定します。
パターン検索時に文字の大小を区別するかどうかを設定します。
コメントを検索対象から外します。
不適切なパターンを発見したときに表示するメッセージを設定します。
ファイルの最後が改行で終わっているかどうかをチェックします。
改行で終わっていないファイルは、UNIXシステムなどで処理したときに
最後の1行が省かれてしまう可能性があります。
改行文字を設定します。
システムのデフォルト改行文字を使います。
Windows形式の改行文字を使います。
Mac形式の改行文字を使います。
Unix形式の改行文字を使います。
チェック対象とするファイルの拡張子を設定します。
デフォルトでは、全ての拡張子が対象になります。
TODOコメントをチェックします。
TODOコメントを検索するパターンを正規表現で設定します。
デフォルトは TODO: です。
国際化ファイルのキー同一チェックを行います。
国際化ファイルの拡張子を設定します。
デフォルトは properties です。
例えば、以下のような2つのファイルがあるとします。
messages.properties
hello=Hello cancel=Cancel
messages_de.properties
hell=Hallo ok=OK
比べてみるとわかるように、これらはキー項目が統一されていません。
チェックに掛けると、以下のようなメッセージが出力されます。
messages_de.properties: Key 'hello' missing. messages_de.properties: Key 'cancel' missing. messages.properties: Key 'hell' missing. messages.properties: Key 'ok' missing.
main メソッドをチェックします。
これは、デバッグ目的で使用された main メソッドが削除されずに残ることを防ぎます。
チェック対象から外すクラス名を正規表現で設定します。
long型の数値を表現するのに L を使っているかどうかチェックします。
long v1 = 10000001L; long v1 = 10000001l; // 小文字のlは数字の1と見間違いやすい
配列の記述形式をチェックします。
メソッドパラメータやcatch節パラメータが final で定義されているかどうかチェックします。
チェック対象を設定します。
特定の条件下で出現するトークンをチェックします。
詳細は不明です。
インデントをチェックします。
基本的なインデント数を設定します。
デフォルトは 4 です。
単独で存在する中括弧のインデント数を設定します。
デフォルトは 0 です。
例えば、インデント数を2に設定すると以下のコードが正となります。
for (...)
{
...
}
case節のインデント数を設定します。
デフォルトは 4 です。
この場合、以下のコードが正となります。
switch (i) {
case 1:
...
break;
}
よく使われている形式は、インデント数を 0 にする形式です。
その場合、以下のコードが正となります。
switch (i) {
case 1:
...
break;
}
行末コメントをチェックします。
チェックから「外す」パターン（// より前の文字列）を正規表現で設定します。
デフォルトは ^[\\s\\}\\);]*$ です。
これは、// より前に 空白文字 } ) ; が出現するパターンとなります。
例を挙げます。
// これは行末コメントではない } // これも行末コメントではない i = 4; // これは行末コメント
行末コメントには、以下のような問題があります。
行末コメントが複数行続く場合、それらを縦一列に綺麗に並べる必要があります。
そうしないと非常に見にくいからです。
行末コメントを記述するには、
たくさんのスペースキーおよびTABキーを連打しなければなりません。
こういう事に時間を使うことによって、
プログラマは他の重要な事を見落す可能性が高くなります。
例えば、行末コメントが複数行続く箇所にもう1行追加しようとした場合
全ての行末コメントを再度フォーマットし直さなければなりません。
これを実行するプログラマはごく稀です。
大抵の場合、前後とのバランスが合わないまま
行末コメントが追加されていくのです。
行末コメントは、1行に収めることが求められます。
本文が長い行に行末コメントを付ける場合、大抵のプログラマは
コメントを画面内に収めるためにコメント内容を省略してしまいます。
その結果、コメント内容は非常にわかりにくく
意味の無いものになってしまうのです。
一番の問題は、行末コメントでは意味のあるコメントを記述し難いという事です。
ほとんどの場合、行末コメントはただ単に行の内容を繰り返しただけの
意味の無いものに成り下がってしまいます。
これはソースに有用でないどころか害を与えます。
以上を踏まえ、行末コメントは
保守およびリファクタリング作業に
多大な影響を与える原因となってしまう事が多いのです。
ファイル内に必ず一度は出現しなければならない文字列をチェックします。
Copyright文などに利用できます。
チェックする文字列を正規表現で設定します。
ファイル内の文字列をチェックします。
このチェックは、RegexpHeader, GenericIllegalRegexp, RequiredRegexp
を統合した機能を持ちます。
チェックする文字列を正規表現で設定します。
複数行の記述も可能です。
このチェックに当てはまったときに表示するメッセージを設定します。
省略すると、Checkstyleのデフォルトメッセージが使用されます。
このパターンが不正なものかどうかを設定します。
デフォルトは false です。この場合、パターンが必須であることを示します。
このパターンが必須のとき、
1ファイル内の出現回数を制限します。
この値を超えて出現するとエラーが返されます。
デフォルトは -1 です。この場合、出現回数は制限されません。
エラーの数がこの値まで達したら、以後このチェックを行いません。
デフォルトは 100 です。
このパターンがコメント内に出現したとき、それを無視するかどうかを指定します。
デフォルトは false です。この場合、コメント内に出現しても無視されません。
|
|