文档介绍：C#注释规范摘自C# LanguageSpecificationC#提供一种机制,使程序员可以使用含有XML文本的特殊注释语法为他们的代码编写文档。在源代码文件中,具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成XML。使用这类语法的注释称为文档注释(ment)。这些注释后面必须紧跟用户定义类型(如类、委托或接口)或者成员(如字段、事件、属性或方法)。XML生成工具称作文档生成器(documentationgenerator)。(此生成器可以但不一定必须是C#编译器本身。)由文档生成器产生的输出称为文档文件(documentationfile)。文档文件可作为文档查看器(documentationviewer)的输入;文档查看器是用于生成类型信息及其关联文档的某种可视化显示的工具。此规范推荐了一组在文档注释中使用的标记,但是这些标记不是必须使用的,如果需要也可以使用其他标记,只要遵循“符合格式标准的XML”规则即可。。这类注释是以三个斜杠(///)开始的单行注释,或者是以一个斜杠和两个星号(/**)开始的分隔注释。这些注释后面必须紧跟它们所注释的用户定义类型(如类、委托或接口)或者成员(如字段、事件、属性或方法)。属性节()被视为声明的一部分,因此,文档注释必须位于应用到类型或成员的属性之前。语法:single-line-ment:/// input-charactersoptdelimited-ment:/** ment-charactersopt */在single-line-ment中,如果当前single-line-ment旁边的每个single-line-ment上的///字符后跟有whitespace字符,则此whitespace字符不包括在XML输出中。在delimited-ment中,如果第二行上的第一个非whitespace字符是一个asterisk,并且在delimited-ment内的每行开头都重复同一个由可选whitespace字符和asterisk字符组成的样式,则该重复出现的样式所含的字符不包括在XML输出中。此样式中,可以在asterisk字符之前或之后包括whitespace字符。示例:///<summary>Class<c>Point</c>modelsapointinatwo-dimensional///plane.</summary>///lassPoint{///<summary>method<c>draw</c>rendersthepoint.</summary>voiddraw(){…}}文档注释内的文本必须根据XML规则()设置正确的格式。如果XML不符合标准格式,将生成警告,并且文档文件将包含一条注释,指出遇到错误。尽管开发人员可自由创建它们自己的标记集,。某些建议的标记具有特殊含义:l<param>标记用于描述参数。如果使用这样的标记,文档生成器必须验证指定参数是否存在以及文档注释中是否描述了所有参数。如果此验证失败,文档生成器将发出警告。lcref属性可以附加到任意标记,以提供对代码元素的参考。文档生成器必须验证此代码元素是否存在。如果验证失败,文档生成器将发出警告。查找在cref属性中描述的名称时,文档生成器必须根据源代码中出现的using语句来考虑命名空间的可见性。l<summary>标记旨在标出可由文档查看器显示的有关类型或成员的额外信息。l<include>标记表示应该包含的来自外部XML文件的信息。注意,文档文件并不提供有关类型和成员的完整信息(例如,它不包含任何关于类型的信息)。若要获得有关类型或成员的完整信息,必须协同使用文档文件与对实际涉及的类型或成员的反射调用。。下列标记提供了用户文档中常用的功能。(当然,也可能有其他标记。)标记章节用途<c><code><example><exception><include><list><para><param><paramref><permission><summary><returns><see>