XML派生クラスまたはインターフェイス実装のソースコードのコメント

Question

私の前の質問に関連しています。私がインターフェースを定義すると、そのメンバーにコメントするでしょう。元のコメントがもう有効でない理由がない限り、実装クラスの実装についてコメントしません。

Resharperはこれで問題はないとビジュアルスタジオは警告しています。

重要なことに、継承されたコメントは、あなたがそれらを扱うときにインテリセンスによって表示されます。これは私の唯一の本当の懸念です。

これについてのご意見はありますか？

ありがとうございます。

Answer 1

コードにコメントを追加することは、常に良い方法です。コンポーネントがプライベートクラスまたは内部クラスであり、すべてのコメントが配置された既知のインターフェイスまたは抽象クラスを介して常に公開される場合、そのクラスの実装について特定のものをコメントするだけで済みます（たとえば1人がコードを見たり、数年後にコードに戻ったりしている人が多いでしょう）。そうすれば、コードが何をしているのか、そしてその理由を理解することがより簡単になります。プロジェクトのビルド時にXMLドキュメントが生成されるようにすると、Visual Studioはドキュメント化されていないメンバーを警告します。 Resharperは、XMLドキュメンテーションの生成を有効にしたときに、いくつかのクラスでResharperの警告を受け取っていますが、Resharperはpublic visibilityを持つアイテムについてのみ警告します。 ドキュメンテーションの作業を短縮するには、まずパブリッククラスとインターフェイスをコメントすることをお勧めします（特に製品ライブラリをリリースする場合）。後者についてコメントしない場合は、コードを使って作業しているあなたまたは他の人が、論理とその背後の理由を容易に理解できるようにしてください。