C# 文档注释

C# 提供一种机制，使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中，可以使用特定形式的注释来指导工具从这些注释及其后的源代码元素生成 XML。使用这类语法的注释称为文档注释 (documentation comment)。这些注释后面必须紧跟用户定义的类型（如类、委托或接口）或者成员（如字段、事件、属性或方法）。该 XML 生成工具称为文档生成器。（此生成器可以但不需要是 C# 编译器本身。）文档生成器生成的输出称为文档文件。文档文件用作文档查看器（一个用于生成类型信息及其关联文档的某种可视显示的工具）的输入。


此规范推荐了一组在文档注释中使用的标记，但是这些标记不是必须使用的，如果需要也可以使用其他标记，只要遵循“格式良好的 XML”规则即可。