13

そのため、コードで XML コメントを使用してパブリック メソッドとパブリック メンバーを説明しています。別の開発者は、私のメソッドのすべてに XML コメントがあるわけではないと述べています。公開または保護されている場合は XML コメントを追加し、非公開の場合は追加しないというルールを使用します。

これは論理的に聞こえますか?それとも、プライベート メソッドを XML コメントにする何らかの理由があるのでしょうか?

4

5 に答える 5

11

コメントに関する強いルールはありませんが、パブリック/内部/保護されたメソッドにコメントするのは良いことだと思います。

あまり明確でないときは、プライベート メソッドについてコメントすることがあります。理想的には、コードは自己文書化する必要があります。たとえば、次のようなメソッドがある場合

Item GetItemByTitle(string title)

十分に明確なので、コメントを書く必要はありません。ただし、メソッドが他の開発者にとって不明確な場合は、コメントを入力するか、非公開の場合はメソッド イベントの名前を変更/リファクタリングしてください。個人的には、コメントよりもコードを読む方が好きです :) コメントが多すぎると、コードが読みにくくなります。私のルールは、必要な場合にのみコメントを使用することです。

プロジェクトで、プライベート メソッドを含むすべてのメソッドを文書化できる場合は、この規則に従ってください。

于 2013-10-09T09:50:02.690 に答える
8

プライベートおよび保護されたメンバーにもコメントすることは理にかなっています-考えられる理由は次のとおりです。

  • 別の開発者がコードを使用する必要がある場合は、一貫したコメント アプローチが役立ちます。
  • ある時点で、ソース コードのヘルプ/ドキュメント ファイルを自動生成したい場合があります。この場合、Visual Studio の XML コメントがないと、文書化されていないコードが大量に発生する可能性があります。

XML コメントをパブリック メンバーに制限する正当な理由がわかりません。

于 2013-10-09T09:40:43.700 に答える