使用 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 注释标记）。 部分建议标记具有特殊含义：

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

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

    • <summary> 标记由 Visual Studio 中的 IntelliSense 用于显示有关某个类型或成员的附加信息。

若要详细了解如何创建带文档注释的 XML 文件，请参阅以下主题：

请参阅