C＃// vs ///评论

Question

最近我开始使用///来评论我的C＃代码而不是//或/*因为它使用起来要简单得多。 今天我开始想知道为什么有不同的类型并遇到这个问题 ，其中说///注释用于生成xml文档。

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

在我用///评论谜语之前，这种评论是否是一个很大的禁忌？ 以这种方式评论会有潜在的问题吗？

Answer 1

以这种方式评论会有潜在的问题吗？

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

请参见：

XML文档注释（C＃编程指南 ）

如何：为项目生成XML文档

Answer 2

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

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

鉴于这是使用标准//或/ * * / comments的一般惯例，也有可能混淆（或者，更可能是，烦恼）将读取您的代码的其他开发人员。

Answer 3

例如，如果您使用诸如resharper之类的开发帮助工具，大多数情况下，它们会为您提供使用//或/* ... */注释代码块的功能，则可以使用这些工具来注释这些注释的代码块，这对于你曾经有3个斜杠而不是2个。

文档符号的问题是另外一个问题，您将在文档中生成注释，而不必控制代码中留下的注释以及由于您///而已成为文档的原因，但是我想这是一个问题可以在文档生成工具中配置。