2017-10-31 55 views
0

Checkstyleを設定してjavadocコメントが空であると警告することができますか?Checkstyleが空のjavadocコメントを検出しない

のCheckstyle destが(Javadocコメントが完全に欠落している)以下の場合には、私を警告していない:

/** 
* 
*/ 
public enum MyType{ EQUALS } 

私はドキュメントhereをチェックしましたが、私はこの問題に関連何も表示されませんでした。

+0

を、あなたはこれをチェックするのCheckstyleを設定していますか?どのチェックをトリガーする予定ですか? –

+0

私はドキュメントをチェックしましたが、この問題に関連するものは何も見つかりませんでした。私は設定ファイルにどのプロパティを設定する必要があるか分かりません。 – zappee

+0

それは欠けていません、それは空です。 –

答えて

0

これを行うには、Javadoc CommentsセクションのStyle Javadoc Checkstyleモジュールを使用できます。 Checkstyleからdocumentation on Style Javadoc

正しい形式であることを確認するためにJavadocのコメントを検証します。 次のチェックが実行されます。

  • は、最初の文は適切な句読点(これはデフォルトでは、期間、疑問符、または感嘆符である)で終了するようにします。 Javadoc はメソッドサマリテーブル とindexに自動的に最初のセンテンスを配置します。適切な句読点がないと、Javadocが不正な形式になっている可能性があります。 {@inheritDoc}タグの対象となるすべてのアイテムは、この 要件から免除されています。
  • 説明がないJavadocステートメントのテキストを確認してください。これには、完全空のJavadocと@paramや@returnなどの タグを持つJavadocの両方が含まれます。

checkEmptyJavadocチェックボックスをチェックすることを確認してください:まあ

Style Javadoc

関連する問題