通过

使用 XML 记录代码（Visual Basic）

在 Visual Basic 中，可以使用 XML 记录代码。

XML 文档注释

Visual Basic 提供了一种为项目自动创建 XML 文档的简单方法。 可以为类型和成员自动生成 XML 框架，然后为每个参数提供摘要、描述性文档以及其他注释。 使用适当的设置，XML 文档会自动发送到与项目具有相同根文件名的 XML 文件中。 有关配置 XML 文档文件的生成的信息，请参阅 -doc 编译器选项 和 GenerateDocumentationFile MSBuild 属性。

XML 文件可以被使用或按 XML 形式进行其他操作。 此文件与项目的输出 .exe 或 .dll 文件位于同一目录中。

XML 文档以 ''' 开头。 处理这些注释有一些限制：

  • 文档必须是格式正确的 XML。 如果 XML 格式不正确，则会生成警告，文档文件包含一条注释，指出遇到错误。

  • 开发人员可以自由创建自己的一组标记。 建议使用一组标记（请参阅 XML 注释标记）。 部分建议标记具有特殊含义：

    • 参数<>标记用于描述参数。 如果使用，编译器将验证参数是否存在，以及文档中是否描述了所有参数。 如果验证失败，编译器会发出警告。

    • cref 属性可以附加到任何标记，以提供对代码元素的引用。 编译器验证此代码元素是否存在。 如果验证失败，编译器会发出警告。 编译器在查找Imports属性中描述的类型时也遵循任何cref语句。

    • 在 Visual Studio 中，IntelliSense 使用 <summary> 标记来显示有关类型或成员的附加信息。

有关使用文档注释创建 XML 文件的详细信息，请参阅以下主题：

另请参阅