ソースファイルの先頭に記述されるべきヘッダ内容をチェックします。
ヘッダには主にライセンス文が記述されます。
これはプロジェクトで統一しておく事をお勧めします。
固定ヘッダ内容をチェックします。
ヘッダ内容を記述したファイルを設定します。
ヘッダ内容を直接文字列で設定します。
ヘッダ内容中、チェックの対象外とする行数をカンマ区切りで指定します。
line 1: //////////////////////////////////////////////////////////////////// line 2: // checkstyle: line 3: // Checks Java source code for adherence to a set of rules. line 4: // Copyright (C) 2002 Oliver Burn line 5: ////////////////////////////////////////////////////////////////////
例えばこのようなヘッダの場合、年数の部分は場面に応じて変更する可能性もあります。
そこで、 ignoreLines を 4 と設定することで
この行をチェック対象から外すことが出来ます。
正規表現を利用した動的ヘッダ内容をチェックします。
ヘッダ内容を記述したファイルを設定します。
ヘッダ内容を直接文字列で設定します。
ヘッダ内容のうち、繰り返しを許可する行数をカンマ区切りで指定します。
line 1: ^/{71}$
line 2: ^// checkstyle:$
line 3: ^// Checks Java source code for adherence to a set of rules\.$
line 4: ^// Copyright \(C\) \d\d\d\d Oliver Burn$
line 5: ^// Last modification by \$Author.*\$$
line 6: ^/{71}$
line 7:
line 8: ^package
line 9:
line 10: ^import
line 11:
line 12: ^/\*\*
line 13: ^ \*([^/]|$)
line 14: ^ \*/
例えばこのようなヘッダの場合、10行目のimport文や13行目のJavadocコメントは
複数行に及ぶ可能性があるので multiLines を 10, 13 と設定することで
これらの行が繰り返し記述されることを許可することが出来ます。
正規表現を利用した動的ヘッダ内容をチェックします。
RegexpHeader とほぼ同じですが、こちらは Java ファイル以外のリソースも
チェックすることができます。
例えばシェルスクリプトの先頭に #!/bin/sh が記述されているかなど、
より広範囲のチェックに利用できます。
ファイルの文字エンコーディングを指定します。
対象とするファイルの拡張子をカンマ区切りで指定します。
ヘッダ内容を記述したファイルを設定します。
ヘッダ内容を直接文字列で設定します。
ヘッダ内容のうち、繰り返しを許可する行数をカンマ区切りで指定します。