本文包含三个示例，演示如何向大多数 C# 语言元素添加 XML 文档注释。 第一个示例演示如何记录具有不同成员的类。 第二个示例演示如何重用类或接口层次结构的说明。 第三个示例展示用于泛型类和成员的标记。 第二个和第三个示例使用第一个示例中介绍的概念。
下面的示例展示了公共语言元素，以及可能用于描述这些元素的标记。 文档注释说明标记的使用，而不是类本身。
添加文档可使你的源代码与面向库用户的大量注释混杂在一起。 使用 标记可将 XML 注释与源代码分隔开来。 源代码引用包含 标记的 XML 文件：
第二个文件 xml_include_tag.xml 包含文档注释。
元素表示类型或成员从基类或接口继承文档注释。 还可将 元素与 属性配合使用，以从同一类型的成员继承注释。 下面的示例介绍使用此标志的方法。 请注意，将 属性添加到类型时，将继承成员注释。 可对派生类型的成员编写注释来阻止使用继承的注释。 这些注释将优先于继承的注释被选中。
使用 标记描述泛型类型和方法的类型参数。 属性的值需要新语法才能引用泛型方法或类：
下面的代码真实地演示如何将文档注释添加到 math 库。
你可能会发现代码已被所有注释遮盖。 最后一个示例演示如何调整此库以使用 标记。 将所有文档移到 XML 文件中：
在上面的 XML 中，每个成员的文档注释将直接显示在按其作用命名的标记中。 可选择自己的策略。 该代码使用 标记来引用 XML 文件中的相应元素：
- 属性表示包含文档的 XML 文件的名称。
- 属性表示一个 XPath 查询，该查询的对象为指定的 中的 。
- 属性表示位于注释前的标记中的名称说明符。
- 可用于替换 的 属性表示位于注释前的标记的 ID。
版权声明：
本文来源网络，所有图片文章版权属于原作者，如有侵权，联系删除。
本文网址：https://www.mushiming.com/mjsbk/13654.html