C#// vs ///评论

时间:2012-11-14 06:14:40

标签: c#

最近我开始使用///来评论我的C#代码,而不是///*,因为它使用起来要简单得多。今天我开始想知道为什么有不同的类型并遇到this SO question,其中指出///注释用于生成xml文档。

关于评论类型与Google上的其他评论类型相比,我找不到任何建议,我认为这意味着无论哪种方式都无关紧要。到目前为止,我没有使用///来评论任何不良影响,但我现在讨厌习惯只是为了以后忘掉它。据我所知,如果评论中没有元标记,它就不会被认为是文档(或者我完全错了吗?)

在我用///条评论谜语之前,这种评论是否是一个很大的禁忌?通过这种方式发表评论会有潜在的问题吗?

3 个答案:

答案 0 :(得分:6)

  

以这种方式发表评论会有潜在的问题吗?

是。当您决定生成项目文档时,它将所有这些注释行作为XML文档的一部分。使用/Doc扩展编译代码时,它会使用您的XML注释(///)生成文档。如果您已使用它来注释掉您的代码,那么文档生成将考虑文档的注释掉的代码。

请参阅:

XML Documentation Comments (C# Programming Guide

How to: Generate XML Documentation for a Project

答案 1 :(得分:1)

就代码编译而言,没有任何技术差异。他们都被忽略了。

我相信///评论更像是一个约定,表示您正在使用XML Documentation Comments对特定代码块进行评论。像Visual Studio这样的IDE可以识别不同的注释类型,并相应地进行视觉设计。

鉴于这是使用标准//或/ * * / comments的一般惯例,也有可能混淆(或者,更有可能是,惹恼)将阅读您的代码的其他开发人员。

答案 2 :(得分:0)

如果您使用像resharper这样的开发帮助工具,例如他们主要为您提供了使用///* ... */注释acode块的功能,可以使用这些工具来填充这些注释的代码块,一旦你有3个斜杠而不是2个,这对你不起作用。

文档符号的问题是另一个问题,您将获得在文档中生成的注释,而无法控制代码中的内容以及因为您拥有///而进入文档的内容,但是我想这是一个可以在文档生成工具中配置的问题。