3

私が取り組んでいるプロジェクトでは、プライベートメンバー変数に Javadoc コメントがないため、checkstyle が「Javadoc コメントがありません」で失敗します。これは私には不必要に厳密な動作のように思えます。抑制 XML ファイルを使用してプライベート メンバーのエラーを抑制したいと考えています。

次のファイルは、変数に関するすべてのcheckstyle Javadoc エラーの抑制に成功しています。

<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <suppress files=".*" checks="JavadocVariable"/>
</suppressions>

ただし、保護されたメンバーとパブリックメンバーを文書化できないことはエラーであると私はまだ考えているため、これはあまり有用な動作ではありません。

checks属性を変更して、必要な抑制を制限するにはどうすればよいですか?

4

1 に答える 1

2

Afaik、これは、すべてのプライベート フィールドに注釈を付けたい場合を除き、抑制を使用して達成することはできません。代わりに、プライベート スコープをカバーしないようにJavadocVariableチェックを構成します。

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

範囲のpackage意味は「またはpackageより一般的」です。

于 2015-04-27T19:26:37.060 に答える