Checkstyle チェック項目ーHeaders

Checkstyleチェック項目：Headers

CheckStyle公式ドキュメント

ver 10.3.1

RegexpHeader

ソースファイルのヘッダを、ソースヘッダの各行に対応するパターンを含むヘッダと照合してチェックする。

プロパティ

プロパティ	型	デフォルト値	説明
headerFile	URI	null	必要なヘッダーを含むファイル名を指定
charset	String	Checkerモジュールのcharsetプロパティ	headerFileを読み込む際に使用する文字エンコーディングを指定
header	String	null	インラインで指定された必要なヘッダーを指定します。個々のヘッダー行は、文字列 "∕n" で区切る必要がある。
multiLines	int[]	{}	繰り返す行番号を指定する（0回以上）
fileExtensions	String[]	all files	処理するファイルのファイルタイプ拡張子を指定

チェック設定例

プロパティ設定なし

<module name="RegexpHeader"/>

プロパティ設定あり

<module name="RegexpHeader">
  <property name="header" value="^// Copyright \(C\) (\d\d\d\d -)? 2004 MyCompany$ \n^// All rights reserved$"/>
</module>

チェック実行例

プロパティ設定なし

プロパティ未設定の場合はチェックされない

プロパティ設定あり

^// Copyright \(C\) (\d\d\d\d -)? 2004 MyCompany$
^// All rights reserved$
package Test;

public class MyClass{
    
}

---

Header

ソースファイルが指定されたヘッダで始まるかどうかをチェックする。

プロパティ

プロパティ	型	デフォルト値	説明
headerFile	URI	null	必要なヘッダーを含むファイル名を指定
charset	String	Checker モジュールの charset プロパティ	headerFileを読み込む際に使用する文字エンコーディングを指定
header	String	null	インラインで指定された必要なヘッダーを指定します。個々のヘッダー行は、文字列 "∕n" で区切る必要がある。
ignoreLines	int[]	{}	無視する行番号を指定
fileExtensions	String[]	all files	処理するファイルのファイルタイプ拡張子を指定

チェック設定例

プロパティ設定なし

<module name="Header"/>

プロパティ設定あり

<module name="Header">
    <property name="header" value="// Copyright (C) 2004 MyCompany\n// All rights reserved"/>
</module>

チェック実行例

プロパティ設定なし

設定がない場合はチェックが行われない

プロパティ設定あり

// OK
// Copyright (C) 2004 MyCompany
// All rights reserved
package Test;

public class MyClass{
    
}