20

当我突然在评论中输入一个 3'd '/' 时，我正在 lala 土地上编码。最初的评论变为绿色，带有 2 '/'s ：

主题1

但随着第三个破折号，它变成灰色'///' ：

主题2

这有什么具体含义吗？还是只是改变了颜色？

4

3 回答 3

33

它表示一个 XmlComment，可以在MSDN上阅读更多内容。例如，

/// <summary>
/// Method summary  - a method that does something
/// </summary>
/// <param name="i">Description of param</param>
/// <param name="s">Description of param</param>
/// <returns>An object of some sort or other</returns>
public object AMethod(int i, string s)
{
}

编辑：如下图所示，它还提供IntelliSense指导，如下图所示。

在此处输入图像描述

于 2012-05-03T15:09:48.760 回答
5

三斜杠注释用于文档生成器。您可以直接从源代码生成 API 文档。你可以在你的源代码中记录你的 API 做了什么，它需要什么参数，它抛出什么异常等等。Microsoft 提供工具来验证您的文档是否与实际 API 同步。例如，如果您添加、删除或重命名参数，但忘记记录更改，您将收到警告。

这是您使用 Visual Studio 从这些标签生成文档的方式：link。

于 2012-05-03T15:10:03.213 回答
1

///用于 XML 注释。它提供了 XML 格式的注释。您还可以/doc:在编译时使用选项从中创建 XML 文档，例如

csc /doc:filedoc.xml program.cs
于 2012-05-03T15:16:37.383 回答