建议的用于文档注释的 XML 标记 (Visual Basic)

更新：2007 年 11 月

Visual Basic 编译器可将代码中的文档注释处理为 XML 文件。可以使用其他工具将 XML 文件处理为文档。

在代码构造（如类型和类型成员）上允许 XML 注释。对于分部类型，虽然对如何注释其成员没有限制，但只有类型的一部分可以有 XML 注释。

说明：
文档注释不能应用于命名空间。原因是一个命名空间可以跨越几个程序集，而且不必同时加载所有程序集。

编译器会处理任何为有效 XML 的标记。下列标记提供了用户文档中常用的功能。

<c>	<code>	<example>
<exception>1	<include>1	<list>
<para>	<param>1	<paramref>
<permission>1	<remarks>	<returns>
<see>1	<seealso>1	<summary>
<typeparam>1	<value>

(（¹ 编译器会验证语法。）

说明：
如果想要尖括号出现在文档注释文本中，使用 &lt; 和 &gt;。例如，字符串 "&lt;text in angle brackets&gt;" 将显示为 <text in anglebrackets>。

请参见

任务

如何：在 Visual Basic 中创建 XML 文档

概念

使用 XML 将代码文档化 (Visual Basic)

参考

/doc