3

最近我开始使用///来注释我的 C# 代码,而不是//因为/*它更易于使用。今天我开始想知道为什么会有不同的类型,并遇到了这个 SO question,它指出///评论是用于生成 xml 文档。

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

在我用注释混淆我的代码之前///,这种类型的注释是一个很大的禁忌吗?以这种方式发表评论会不会有潜在的问题?

4

3 回答 3

6

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

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

请参见:

XML 文档注释(C# 编程指南

如何:为项目生成 XML 文档

于 2012-11-14T06:18:29.450 回答
1

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

我相信 /// 注释更像是一种约定,表示您正在使用XML Documentation Comments注释特定的代码块。像 Visual Studio 这样的 IDE 可以识别不同的注释类型,并会在视觉上做出相应的样式。

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

于 2012-11-14T06:26:20.673 回答
0

如果您使用诸如 resharper 之类的开发帮助工具,例如,它们主要为您提供使用//或 with注释代码块的功能/* ... */,这些注释代码块可以使用这些工具切换,一旦您有 3 个斜杠而不是 2 个,这对您不起作用.

文档符号的问题是另一个问题,您将在文档中生成注释,而无需控制代码中的注释以及进入文档的内容,因为您已经全部完成了///,但我想这是一个可以解决的问题在文档生成工具中配置。

于 2012-11-14T06:21:33.107 回答