连续3'/'在C#中做什么？

Question

当我突然在评论中输入3分'/'时,我正在lala land编码.最初的评论是绿色的2'/ :

但是使用第三个破折号,它变为灰色 '///' :

这有什么特别的含义吗？或者只是改变了颜色？

Answer 1

它表示一个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指导,如下图所示.

Answer 2

三个斜杠注释适用于文档构建器.您可以直接从源生成API文档.您可以在源代码中记录您的API所执行的操作,所需的参数,抛出的异常等.Microsoft提供了用于验证文档是否与实际API同步的工具.例如,如果添加,删除或重命名参数,但忘记记录更改,则会收到警告.

这是使用Visual Studio:link从这些标记生成文档的方法.