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

【问题标题】：What would be some particular benefits to using GhostDocs with C#将 GhostDocs 与 C# 结合使用有什么特别的好处
【发布时间】：2012-08-14 22:04:33
【问题描述】：

GhostDocs 的重点显然是记录您的代码。它要求您很好地命名您的方法。然而，对于命名良好的方法，理论上它们不应该足够有用以被视为文档吗？

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

【问题讨论】：

过去我用过很多GhostDocs，但发现我这些天越来越少用了。我的方法名称很好且具有描述性，而且这些方法通常很小（5-10 行）。因此，当您使用类时，每种方法的作用很容易理解。但是，当您在其他类中使用 xml 文档时非常方便 - 因为如果您使用 Sandcastle 之类的东西来构建 MSDN 样式文档以配合您的代码。

标签： c# ghostdoc

【解决方案1】：

虽然自文档化代码会有所帮助，但如果您只需要它，没有人会参考 MSDN（顺便说一下，它是 .NET 库本身中 XML 文档的扩展、语言合并的 HTML 形式）。

XML-doc cmets 允许您比使用标识符更详细地描述类、方法、参数和其他成员。您可以推荐最佳实践，阻止对代码的不正确或“hack-y”使用，详细说明可能出错的原因以及原因等。当您的源代码不正确时（如果您正确编译），此信息可用，并且当您的代码不像您想象的那样自我记录时，这是非常宝贵的（您可能认为显而易见的许多事情是因为您以某种方式思考，而不是每个人都会以相同的方式思考）。

【讨论】：