C#中的<summary>

初学C#，看公司代码的过程中一步一步学习，现将学习过程中发现的一些知识总结整理出来，无论难易，以供后续不时之需。

在C#中，<summary> 标记应当用于描述类型或类型成员。 使用 <remarks> 添加针对某个类型说明的补充信息。 使用 cref 特性可启用文档工具（如Sandcastle）来创建指向代码元素的文档页内部超链接。

<summary> 标记的文本是唯一有关 IntelliSense 中的类型的信息源，它也显示在 Object Browser Window 中，使用 /doc 进行编译可以将文档注释处理到文件中。 若要基于编译器生成的文件创建最终文档，可以创建一个自定义工具，也可以使用 Sandcastle等工具。

生成<summary>注释的方法很简单，在方法之前输入 /// 就会自动生成。如下（实际代码演示）：

    /// <summary>
    /// 这里是测试信息。
    /// </summary>
    /// <param name="timeline"></param>
    /// <param name="cardtype"></param>
    /// <param name="jdtime"></param>
    /// <returns></returns>

我是在函数 private string getCardType(string[] timeline, string cardtype, string jdtime) 前添加的注释，当我在代码其他位置把鼠标放在 getCardType（）函数上时，就会自动跳出黄色提示框，显示 <summary>内容，即上文中的 “” 这里是测试信息。“”。

在 Visual C# 中，可以通过以下方法为代码创建文档：紧接在源代码中 XML 标记引用的代码块的前面，使用特殊的注释字段包括 XML 标记。