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

此示例演示如何在代码中添加 XML 文档注释。

提示

对于在以下说明中使用的某些 Visual Studio 用户界面元素,您的计算机可能会显示不同的名称或位置。这些元素取决于您所使用的 Visual Studio 版本和您所使用的设置。有关更多信息,请参见 Visual Studio 设置

为类型或成员创建 XML 文档

  1. 在**“代码编辑器”**中,将鼠标放置在要创建文档的类型或成员上方的行中。

  2. 类型 '''(三个单引号)。

    在**“代码编辑器”**中添加该类型或成员的 XML 主干。

  3. 在相应的标记之间添加描述性信息。

    提示

    如果在 XML 文档块中添加其他行,每行必须以 ''' 开头。

  4. 用新的 XML 文档注释添加其他使用该类型或成员的代码。

    IntelliSense 会显示该类型或成员的 <summary> 标记中的文本。

  5. 编译此代码,以生成包含该文档注释的 XML 文件。 有关更多信息,请参见 /doc

请参见

参考

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

/doc

概念

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