最近我开始使用///
来评论我的C#代码,而不是//
或/*
,因为它使用起来更简单。今天,我开始想知道为什么有不同的类型,并遇到this SO question其中指出///
注释是用于生成XML文档。C#// vs ///评论
对于Google上的评论类型和其他评论,我无法找到任何建议,我认为这两者无关。到目前为止,我还没有从使用///
发表任何不良影响发表评论,但我不想现在就养成一种习惯,以后再忘记。据我所知,如果在评论中没有元标记,它不会被识别为文档(或者我完全错了吗?)
在我用///
注释谜语之前,是这种类型的评论一个大的禁忌?这样评论会有潜在的问题吗?
三个斜线用于描述已声明的方法或函数。我只知道这一点。 –
我其实刚刚回答了一个问题,解释今天的差异。 http://stackoverflow.com/questions/13366400/should-you-use-xml-comments-on-field-variables-properties-constructors/13366665#13366665 – evanmcdonnal
是什么让你认为代码文档是否定的? – Euphoric