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

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

代码构造(如类型和类型成员)允许使用 XML 注释。 对于分部类型,只有一部分类型可以有 XML 注释,尽管对其成员进行注释没有限制。

注释

文档注释不能应用于命名空间。 原因是一个命名空间可以跨越多个程序集,并非所有程序集都必须同时加载。

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

1 编译器验证语法。

注释

如果希望尖括号显示在文档注释的文本中,请使用 &lt;&gt;。 例如,字符串 "&lt;text in angle brackets&gt;" 将显示为 <text in angle brackets>.

另请参阅