1

一貫性を保つために、単純なゲッターとセッターのメソッドや非常に小さなラッパークラスであっても、すべてのメソッドとクラスに(JavaDocの形式で)コメントを常に適用しています。しかし、私はまた、コメントを不要にすることが多い自己文書化コードの記述にも努めています。つまり、必要な場所にのみコメントを書き込みます(その前に、コメントがまったく必要ないようにコードを書き直してみてください)。したがって、これら2つのアプローチは互いに矛盾しているように見えます。

では、メソッドまたはクラスを説明するコメントは一貫した方法で適用する必要がありますか、それともそのようなコメントは、定義から意味が完全に明確でない場合にのみ書き込む必要がありますか?

4

2 に答える 2

1

以前はすべてのメソッドのコードを作成していましたが、現在は、コメントによってコード自体よりも多くの情報が追加された場合にのみドキュメントを作成しています。

これは、多くの回答がある同様のトピックに関する質問ですコードが進化するにつれて、ドキュメントの更新が「忘れられる」可能性があります。リンクの質問を参照すると、ドキュメントがまったくないよりも悪いドキュメントの方が悪いです。

于 2010-09-18T09:02:10.933 に答える
1

簡単なリトマス試験は、クラスにコードよりも多くのコメントがあるかどうかを確認することです。はいの場合、それはあなたのコードが複雑すぎて誰にとっても使いにくいことを意味します。

したがって、自明のコードを書くのが最善です。また、セッターやゲッターのように明らかなことについてコメントを書く必要はありません。

ですから、そのようなコメントは、定義から意味が完全に明確でない場合にのみ書かれることにします。

于 2010-09-18T08:48:30.940 に答える