1

多くのゲッターとセッターを含むコードサンプルには、次のCHECKSTYLE表記があります。

/* CHECKSTYLE:OFF */
public void setDisplayName(final String displayName) {
    this.displayName = displayName;
}
/* CHECKSTYLE:ON */

/* CHECKSTYLE:OFF */
public String getDisplayName() {
    return displayName;
}
/* CHECKSTYLE:ON */

これによりコードが混乱し、読みにくくなることがわかりました。

この例のように、これらの表記がすべてのメソッド定義の最初と最後にならないように、これらの表記を追加する簡単な方法はありますか？

4

2 に答える 2

2

allowMissingPropertyJavadoc プロパティを使用して、getter および setter で javadoc を必要としないようにJavadoc メソッド Checkstyle 構成を更新しようとしましたか?

getter と setter の javadoc をフィルタリングしただけなのか、それとももっと複雑なものなのかにもよりますが、これはより良い、よりクリーンなソリューションになる可能性があります。

于 2010-08-29T16:46:33.867 に答える
1

参照する表記法は、コメントのペアを使用して監査イベントを抑制する SuppressionCommentFilterと呼ばれます。このリンクで説明されているように、コードでこれらの抑制を行う代わりに、別のファイルでそれらを維持することができます: SuppressionFilter

ただし、状況に応じて、コードでそれを維持する理由があります。

これが問題のコードの問題であり、個人的な好みではない場合、ポリシーをオーバーライドするのに最適な場所はコード自体です。半構造化コメントをチェックに関連付けることができます。これは、ソース ファイルが編集されるたびに最新の状態に保つ必要がある個別の抑制ファイルよりも優れている場合があります。

于 2010-08-16T14:07:23.330 に答える