为自己的类添加说明文字
http://msdn.microsoft.com/library/chs/default.asp?url=/library/CHS/csref/html/vcwlkXMLDocumentationTutorial.asp
这将创建 XML 文件 XMLsample.xml,您可以在浏览器中或使用 TYPE 命令查看该文件。
文档必须是符合标准格式的 XML。如果 XML 不符合标准格式,将生成警告,并且文档文件将包含一条注释,指出遇到错误。有关符合标准格式的 XML 的更多信息,请参见 XML 词汇表。 开发人员可自由创建自己的标记集。有一套建议的标记(请参见“其他阅读材料”部分)。某些建议的标记具有特殊含义: <param> 标记用于描述参数。如果使用,编译器将验证参数是否存在,以及文档中是否描述了所有参数。如果验证失败,则编译器发出警告。 cref 属性可以附加到任意标记,以提供对代码元素的引用。编译器将验证该代码元素是否存在。如果验证失败,则编译器发出警告。查找 cref 属性中描述的类型时,编译器还考虑任何 using 语句。 <summary> 标记由 Visual Studio 内的“智能感知”使用,用来显示类型或成员的其他相关信息。
若要将生成的 .xml 文件用于智能感知功能,请使该 .xml 文件的文件名与要支持的程序集同名,然后确保该 .xml 文件放入与该程序集相同的目录中。这样,在 Visual Studio 项目中引用程序集时,也可找到该 .xml 文件。
单击“生成”属性页。 修改“XML 文档文件”属性。 <summary></summary> 描述类型成员。 <remarks></remarks> 指定类或其他类型的概述信息。 <param></param> 在方法声明的注释中使用以描述该方法的一个参数。 <returns></returns> 在方法声明的注释中使用以描述返回值。 <newpara></newpara> 在注释中开始一个新段落。