c# - フィールド変数、プロパティ、およびコンストラクターに XML コメントを使用する必要がありますか?

Question

これまでのところ、クラス メソッドに XML コメントを付けるのが良い方法であることは理解していますが、XML コメントをどの程度使用するべきかについての標準はありますか?

フィールド変数、プロパティ、およびコンストラクターを文書化するためにそれらを使用する必要がありますか、それともやり過ぎですか?

Web を見てみましたが、この種の厳格な規則は見当たりません。

Answer 1

プレーンな英語ではなく XML コメントを使用する理由は 2 つあります。

1. コメントが正しい形式に従っている場合、それらは IntelliSense に表示されます。つまり、クラスを使用するint aと、.NET メソッドを使用しているときに役立つ情報が表示されるのと同じように、それがカウントであると想定されていることがわかります。

2. Microsoft がサポートする XML 形式を使用する場合は、SandCastle または同様のサード パーティ ユーティリティを使用して、html (またはその他の形式の) ドキュメントを作成できます。

したがって、コメントを書くのに時間がかかる場合は、VS が推奨する XML コメントにすることもできます。