C# 将GhostDocs与C结合使用有什么特别的好处#

GhostDocs的全部目的显然是记录您的代码。它要求您命名好您的方法，以便这样做。然而，对于命名良好的方法，从理论上讲，它们不应该足够有用，可以被视为文档吗

---

我只想听听当前用户的一些优点/缺点，因为我不想下载它，也不想用不必要和重复的文档把我的代码弄得乱七八糟。

虽然自我文档化代码有帮助，但如果它是你所需要的，没有人会咨询MSDN（顺便说一句，它是.NET库中XML文档的一种扩展的、语言合并的HTML形式）

---

XML文档注释允许您比使用标识符更详细地描述类、方法、参数和其他成员。您可以推荐最佳做法，阻止对代码的不正确或“黑客式”使用，详细说明可能出现的错误以及原因等。当源代码不可用时，可以使用此信息（如果您正确地编译了它），并且当您的代码不像您想象的那样具有自文档性时，它是非常宝贵的（许多您可能认为显而易见的事情是因为您以某种方式思考，而不是每个人都会以同样的方式思考）.

过去我经常使用GhostDocs，但现在我发现我使用它的次数越来越少。我的方法名称很好，描述性很强，而且方法通常很小（5-10行）。因此，当您使用这些类时，每个方法所做的事情都很容易理解。但是，当您在其他类中使用xml文档时，它非常方便—如果您使用诸如Sandcastle之类的工具来构建MSDN样式的文档以与您的代码配合使用的话。