GhostDocs 的重点显然是记录您的代码。它要求您很好地命名您的方法。然而，对于命名良好的方法，理论上它们不应该足够有用以被视为文档吗？
我只想听听当前用户的一些优点/缺点，因为我不想下载它并用不必要和重复的文档弄乱我的代码。
问问题
231 次
1 回答
2
虽然自记录代码会有所帮助，但如果您只需要它，那么没有人会参考 MSDN（顺便说一下，它是 .NET 库本身中 XML 文档的扩展的、语言合并的 HTML 形式）。
XML-doc 注释允许您描述类、方法、参数和其他成员，这比使用标识符更详细。您可以推荐最佳实践，阻止对代码的不正确或“hack-y”使用，详细说明可能出错的原因以及原因等。当您的源代码不正确时（如果您正确编译），此信息可用，并且当您的代码不像您想象的那样自我记录时，这是非常宝贵的（您可能认为很明显的许多事情是因为您以某种方式思考，而不是每个人都会以相同的方式思考）。
于 2012-08-14T22:08:50.317 回答