c# - GhostDocsをC＃で使用することの特別なメリットは何ですか？

Question

GhostDocsの要点は、明らかにコードを文書化することです。そのためには、メソッドに適切な名前を付けるように求められます。ただし、適切な名前のメソッドを使用すると、理論的には、ドキュメントと見なされるほど有用ではないでしょうか。

ダウンロードして不要で重複するドキュメントでコードを乱雑にしたくないので、現在のユーザーの賛否両論を聞きたいだけです。

Answer 1

自己文書化コードは役立ちますが、必要なものがすべてあれば、MSDN（ちなみに、.NETライブラリ自体のXMLドキュメントの拡張された言語マージされたHTML形式）を参照する人は誰もいません。

XML-docコメントを使用すると、クラス、メソッド、パラメーター、およびその他のメンバーを、識別子を使用する場合よりも詳細に説明できます。ベストプラクティスを推奨し、コードの誤った使用や「ハックのような」使用を思いとどまらせ、何がうまくいかないのか、その理由などを詳しく説明します。この情報は、ソースコードが正しくない場合（適切にコンパイルした場合）に利用できます。コードが思ったほど自己文書化されていない場合は非常に貴重です（明らかだと思うことが多いのは、特定の方法で考えているためであり、すべての人が同じように考えているわけではありません）。