将GhostDocs与C#一起使用会有什么特别的好处

时间:2012-08-14 22:04:34

标签: c# ghostdoc

GhostDocs的重点显然是记录你的代码。它要求您为这些方法命名。但是,如果使用命名良好的方法,理论上它们不应该足以被视为文档吗?

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

1 个答案:

答案 0 :(得分:2)

虽然自我记录代码有帮助,但如果只是你需要的话,没有人会咨询MSDN(顺便说一下,这是.NET库本身中XML文档的扩展的,语言合并的HTML形式)。 / p>

XML-doc注释允许您比您想要使用标识符更详细地描述类,方法,参数和其他成员。您可以推荐最佳实践,阻止对代码的错误或“hack-y”使用,详细说明可能出错的原因以及原因等等。当您的源代码不正确时(如果您正确编译它),此信息可用,以及当你的代码不像你想象的那样自我记录时很有价值(许多你可能认为很明显的事情是因为你以某种方式思考,而不是每个人都会以同样的方式思考)。