使用 XML 将代码文档化 (Visual Basic)
在 Visual Basic 中，可以使用 XML 将代码文档化。
XML 文档注释
Visual Basic 提供一种简便方法来自动创建项目的 XML 文档。 您可以先自动生成类型和成员的 XML 主干，然后提供摘要、每个参数的说明性文档及其他备注。 通过进行相应的设置，可以将 XML 文档自动发出到一个 XML 文件中，该文件的名称与项目名称相同，并且扩展名为 .xml。 有关更多信息，请参见 /doc。
此时可以使用该 XML 文件，或者当文件不是 XML 文件时，将其作为 XML 进行操作。 此文件与项目的输出 .exe 或 .dll 文件位于同一个目录中。
XML 文档以 ''' 开头。 对这些注释的处理有一些限制：
文档必须是格式良好的 XML。 如果 XML 格式不良，将生成警告，并且文档文件将包含一条注释，指出遇到错误。
开发人员可自由创建自己的标记集。 本文提供了一组建议的标记（请参见本主题中的“相关章节”） 某些建议的标记具有特殊含义：
<param> 标记用于描述参数。 如果使用，编译器将验证参数是否存在，以及文档中是否描述了所有参数。 如果验证失败，则编译器发出警告。
cref 特性可以附加到任意标记，以提供对代码元素的引用。 编译器将验证该代码元素是否存在。 如果验证失败，则编译器发出警告。 查找 cref 特性中描述的类型时，编译器还将考虑所有 Imports 语句。
<summary> 标记由 Visual Studio 中的 IntelliSense 使用，用来显示有关类型或成员的其他信息。
相关章节
有关创建带有文档注释的 XML 文件的详细信息，请参见下列主题：