JavaDocコメントに関するチェックです。
※Checkstyle 4.3に対応しています。
PackageHtml
パッケージ毎にpackage.htmlが存在するかチェックします。
Properties
◆ fileExtensions
Javaファイルの拡張子を指定します。
Javaファイルが存在するパッケージがチェック対象となります。
デフォルト値はjavaです。
JavadocType
クラスとインターフェイスのJavaDocをチェックします。
Properties
◆ scope
チェック対象とするスコープを指定します。
デフォルト値はprivateです。
◆ excludeScope
チェック対象外とするスコープを指定します。
デフォルト値はnullです。
◆ authorFormat
@authorタグのパターンを正規表現で指定します。
デフォルト値はnullです。
◆ versionFormat
@versionタグのパターンを正規表現で指定します。
デフォルト値はnullです。
◆ tokens
チェック対象を指定します。
デフォルト値はINTERFACE_DEF(インターフェイス),CLASS_DEF(クラス)です。
JavadocMethod
メソッドとコンストラクタのJavaDocをチェックします。
Properties
◆ scope
チェック対象とするスコープを指定します。
デフォルト値はprivateです。
◆ excludeScope
チェック対象外とするスコープを指定します。
デフォルト値はnullです。
◆ allowUndeclaredRTE
java.lang.RuntimeExceptionのサブクラスに対する記述を許可するかどうかを指定します。
デフォルト値はfalseです。
◆ allowThrowsTagsForSubclasses
例外のサブクラスに対する記述を許可するかどうかを指定します。
デフォルト値はfalseです。
◆ allowMissingParamTags
@paramタグがない場合を許可するかどうかを指定します。
デフォルト値はfalseです。
◆ allowMissingThrowsTags
@throwsタグがない場合を許可するかどうかを指定します。
デフォルト値はfalseです。
◆ allowMissingReturnTag
戻り値の型がvoid以外のメソッドで@returnタグがない場合を許可するかどうかを指定します。
デフォルト値はfalseです。
◆ allowMissingJavadoc
JavaDocがない場合を許可するかどうかを指定します。
デフォルト値はfalseです。
◆ allowMissingPropertyJavadoc
プロパティメソッド(setters/getters)のJavaDocがない場合を許可するかどうかを指定します。
デフォルト値はfalseです。
◆ logLoadErrors
??
デフォルト値はfalseです。
◆ suppressLoadErrors
??
デフォルト値はfalseです。
◆ tokens
チェック対象を指定します。
デフォルト値はMETHOD_DEF(メソッド),CTOR_DEF(コンストラクタ)です。
JavadocVariable
変数のJavaDocをチェックします。
Properties
◆ scope
チェック対象とするスコープを指定します。
デフォルト値はprivateです。
◆ excludeScope
チェック対象外とするスコープを指定します。
デフォルト値はnullです。
JavadocStyle
SunのDocCheckを使用してJavaDocをチェックします。
Properties
◆ scope
チェック対象とするスコープを指定します。
デフォルト値はprivateです。
◆ excludeScope
チェック対象外とするスコープを指定します。
デフォルト値はnullです。
◆ checkFirstSentence
最初の文だけをチェックするかどうかを指定します。
デフォルト値はtrueです。
◆ checkEmptyJavadoc
空のJavaDocをチェックするかどうかを指定します。
デフォルト値はfalseです。
◆ checkHtml
不完全なHTMLタグをチェックするかどうかを指定します。
デフォルト値はtrueです。
◆ tokens
チェック対象を指定します。
デフォルト値はINTERFACE_DEF(インターフェイス),CLASS_DEF(クラス),METHOD_DEF(メソッド),CTOR_DEF(コンストラクタ),VARIABLE_DEF(変数)です。
WriteTag
JavaDocタグをチェックします。
Properties
◆ tag
チェック対象とするタグを指定します。
デフォルト値はnullです。
◆ tagFormat
タグのフォーマットを正規表現で指定します。
デフォルト値はnullです。
◆ tagSeverity
警告レベル(ignore,info,warning,error)を指定します。
デフォルト値はinfoです。
コメント