Checkstyle / Module / JavadocComments

• Prev
• Next
• Checkstyle

Javadoc に関連する部分のチェック。

PackageHtml

各パッケージに、package.html が存在しているかをチェック。要は、.java なファイルがあるディレクトリに package.html があるかどうかをチェックする。

記述サンプル

• Standard Checkstyle

  <module name = "PackageHtml">
     <property name = "fileExtensions" value = "java" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.PackageHtmlCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "fileExtensions" value = "java" />
      </config-properties>
  </rule-configuration>

JavadocType

クラス及びインターフェイスでの Javadoc コメントについてチェックします。

記述サンプル

• Standard Checkstyle

  <module name = "JavadocType">
      <property name = "scope" value = "public" />
      <property name = "tokens" value = "CLASS_DEF" />
  </module>

• Plug-in Checkstyle

  <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>

JavadocMethod

メソッドでの Javadoc コメントについてチェックする必要がある場合(チェック対象のタグが存在する場合)にチェックします。

また、あるインターフェイスのメソッドを実装したりスーパークラスのメソッドをオーバーライドした場合に、その実装したメソッドの Javadoc を移してくるのは面倒です。そういった場合のために、@see タグや {@inheritDoc} を使っていても Checkstyle は処理してくれます。

allowThrowsTagsForSubclasses とは、throws で指定されている Throwable なクラスのサブクラスがスローされるときに、@throws タグにそのサブクラスのドキュメントがあればよいとするかどうかを指定するものです。以下のサンプルで確認します。

/**
 * @throws IllegalArgumentException サブクラスのドキュメント
 */
protected void runUnknown() throws RuntimeException {

    throw new IllegalArgumentException();
}

このソースは、allowThrowsTagsForSubclasses が true だとチェックが通り、false だと通りません。

記述サンプル

• Standard Checkstyle

  <module name = "JavadocMethod">
     <property name = "scope" value = "protected" />
     <property name = "allowThrowsTagsForSubclass" value = "true" />
     <property name = "tokens" value = "METHOD_DEF" />
  </module>

• Plug-in Checkstyle

  <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>

JavadocVariable

フィールドでの Javadoc コメントのチェックを行います。

記述サンプル

• Standard Checkstyle

  <module name = "JavadocVariable">
     <property name = "scope" value = "private" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "scope" value = "private" />
      </config-properties>
  </rule-configuration>

JavadocStyle

Javadoc コメントが妥当な書式で書かれているかをチェックします。チェック項目には、以下のようなものがあります。

• 最初の一文が、正しく句読点で終わっているかどうか？ 最初の一文は、javadoc でメソッドの概要や索引に使われています。正しく句読点で終わっていないと、Javadoc が不格好になってしまうかもしれません。
• テキスト内の HTML が整形式になっているかどうか？ このチェックでは、タグの閉じ忘れを検出した場合には、"Unclosed HTML tag found:" というエラーを出します。また、開始タグがないのに終了タグがある場合には、"Extra HTML tag found:" というエラーを出します。

記述サンプル

• Standard Checkstyle

  <module name = "JavadocStyle">
     <property name = "scope" value = "private" />
     <property name = "checkFirstSentence value = "false" />
     <property name = "checkHtml" value = "false" />
  </module>

• Prev
  Checkstyle/Module/Imports
• Next
  Checkstyle/Module/Metrics
• Home
  Up?