Javadoc に関連する部分のチェック。
親モジュール | Checker |
---|---|
実装クラス | com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck(≦3.1) com.puppycrawl.tools.checkstyle.checks.javadoc.PackageHtmlCheck(3.2) |
各パッケージに、package.html が存在しているかをチェック。要は、.java なファイルがあるディレクトリに package.html があるかどうかをチェックする。
プロパティ名 | 型 | デフォルト | 概要 |
fileExtensions | String Set | java | javaファイルであることを表す拡張子を指定。 |
<module name = "PackageHtml"> <property name = "fileExtensions" value = "java" /> </module>
<rule-configuration classname = "com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck" severity = "warning"> <config-properties> <config-property name = "fileExtensions" value = "java" /> </config-properties> </rule-configuration>
親モジュール | TreeWalker |
---|---|
実装クラス | com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck(≦3.1) com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck(3.2) |
クラス及びインターフェイスでの Javadoc コメントについてチェックします。
プロパティ名 | 型 | デフォルト | 概要 |
scope | Scope | private | チェックが行われる可視性スコープ |
excludeScope | Scope | null | (Since 3.4)チェックを行わない可視性スコープ |
authorFormat | Regular Expression | null | @author タグのチェックするパターン |
versionFormat | Regular Expression | null | @version タグのチェックするパターン |
tokens | INTERFACE_DEF, CLASS_DEF | すべて | チェック対象を選択 |
<module name = "JavadocType"> <property name = "scope" value = "public" /> <property name = "tokens" value = "CLASS_DEF" /> </module>
<rule-configuration classname = "com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck" severity = "warning"> <config-properties> <config-property name = "scope" value = "public" /> <config-property name = "tokens" value = "CLASS_DEF" /> </config-properties> </rule-configuration>
親モジュール | TreeWalker |
---|---|
実装クラス | com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck(≦3.1) com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck(3.2) |
メソッドでの Javadoc コメントについてチェックする必要がある場合(チェック対象のタグが存在する場合)にチェックします。
また、あるインターフェイスのメソッドを実装したりスーパークラスのメソッドをオーバーライドした場合に、その実装したメソッドの Javadoc を移してくるのは面倒です。そういった場合のために、@see タグや {@inheritDoc} を使っていても Checkstyle は処理してくれます。
プロパティ名 | 型 | デフォルト | 概要 |
scope | Scope | private | チェックが行われる可視性スコープ |
excludeScope | Scope | null | (Since 3.4)チェックを行わない可視性スコープ |
allowUndeclaredRTE | Boolean | false | RuntimeExceptionが宣言されていない場合をチェックするか? |
allowThrowsTagsForSubclasses | Boolean | false | 長いので後述 |
allowMissingParamTags | Boolean | false | @paramがないのをチェックするか? |
allowMissingThrowsTags | Boolean | false | @throwsがないのをチェックするか? |
allowMissingReturnTag | Boolean | false | @returnがないのをチェックするか? |
tokens | METHOD_DEF, CTOR_DEF | すべて | チェック対象を選択 |
allowThrowsTagsForSubclasses とは、throws で指定されている Throwable なクラスのサブクラスがスローされるときに、@throws タグにそのサブクラスのドキュメントがあればよいとするかどうかを指定するものです。以下のサンプルで確認します。
/** * @throws IllegalArgumentException サブクラスのドキュメント */ protected void runUnknown() throws RuntimeException { throw new IllegalArgumentException(); }
このソースは、allowThrowsTagsForSubclasses が true だとチェックが通り、false だと通りません。
<module name = "JavadocMethod"> <property name = "scope" value = "protected" /> <property name = "allowThrowsTagsForSubclass" value = "true" /> <property name = "tokens" value = "METHOD_DEF" /> </module>
<rule-configuration classname = "com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck" severity = "warning"> <config-properties> <config-property name = "scope" value = "protected" /> <config-property name = "allowThrowsTagsForSubclass" value = "true" /> <config-property name = "tokens" value = "METHOD_DEF" /> </config-properties> </rule-configuration>
親モジュール | TreeWalker |
---|---|
実装クラス | com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck(≦3.1) com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck(3.2) |
フィールドでの Javadoc コメントのチェックを行います。
<module name = "JavadocVariable"> <property name = "scope" value = "private" /> </module>
<rule-configuration classname = "com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck" severity = "warning"> <config-properties> <config-property name = "scope" value = "private" /> </config-properties> </rule-configuration>
親モジュール | TreeWalker |
---|---|
実装クラス | com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck |
Since | 3.2 |
Javadoc コメントが妥当な書式で書かれているかをチェックします。チェック項目には、以下のようなものがあります。
プロパティ名 | 型 | デフォルト | 概要 |
scope | Scope | private | チェックが行われる可視性スコープ |
excludeScope | Scope | null | (Since 3.4)チェックを行わない可視性スコープ |
checkFirstSentence | Boolean | true | 最初の一文の句読点チェックを行うか? |
checkEmptyJavadoc | Boolean | false | (Since 3.4)Javadoc コメントに説明文があるか? |
checkHtml | Boolean | true | テキスト内の HTML が整形式か? |
tokens | INTERFACE_DEF, CLASS_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF | すべて | チェック対象を選択 |
<module name = "JavadocStyle"> <property name = "scope" value = "private" /> <property name = "checkFirstSentence value = "false" /> <property name = "checkHtml" value = "false" /> </module>