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

时间:2012-05-03 15:08:53

标签: c# comments

当我在评论中输入3分'/'时,我正在lala land中编码。最初评论为绿色与2'/'

Subject1

但是使用第三个短划线,它会变为灰色'///'

Subject2

这有什么具体含义吗?或者只是改变颜色?

3 个答案:

答案 0 :(得分:34)

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

Enter image description here

答案 1 :(得分:5)

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

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

答案 2 :(得分:1)

///用于XML注释。它提供XML格式的注释。您也可以使用/doc:选项创建XML文档,同时从

编译
csc /doc:filedoc.xml program.cs