XML 注释示例

更新:2007 年 11 月

本示例演示 Visual Basic 的 XML 注释功能。

获取示例及其安装说明

  • 执行下列一项或多项操作:

    • 在“帮助”菜单上,单击“示例”。

      自述文件将显示有关示例的信息。

    • 访问 Visual Studio 2008 示例网站。该网站提供了最新版本的示例。

    • 在安装了 Visual Studio 的计算机上查找示例。默认情况下,示例和自述文件安装在驱动器号:\Program Files\Microsoft Visual Studio 9.0\Samples\lcid 中。对于 Visual Studio 的速成版,所有示例都可联机找到。

有关更多信息,请参见定位示例文件

安全说明:

此示例代码用于阐释概念,因此仅显示与此概念相关的代码。该代码可能不符合特定环境的安全要求,因此不应原样搬用所显示的代码。我们建议您添加安全性代码和错误处理代码,以使项目更加安全可靠。Microsoft“按原样”提供此示例代码,不提供任何保证。

运行此示例

  • 按 F5。

演示

本示例演示如何创建 XML 注释,在编辑器中查看它们,并以编程方式访问它们。

Automobile 类定义下面的类型元素,每个元素演示 XML 注释的不同方面:

  • **类型   **Automobile 和 EngineOption

  • 属性Model

  • 方法   构造函数、Upgrade、CalculateMaxTowing、WillItTow

  • 事件NeedsTuneUp

  • 委托   RotateTires、ReplaceSparkPlugs

  • 字段   car、modelValue

“创建 Car”按钮的 Click 事件处理程序调用几个 Automobile 成员。使用“代码编辑器”中的 IntelliSense 时,XML 注释显示为工具提示。

“列举摘要”按钮的 Click 事件处理程序使用 XmlDocument 类查询包含 XML 注释的 XML 文件。编译项目时,会创建该 XML 文件并将其与项目程序集一起存储。可在“项目设计器”的“编译”选项卡中指定该文件的位置和名称。

请参见

任务

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