XML Comments Sample

To get samples and instructions for installing them, see the following:

  • Click Samples on the Visual Studio Help menu.

    For more information, see Locating Sample Files.

  • The most recent versions and the complete list of samples are available on the Visual Studio 2008 Samples Web site.

  • You can also locate samples on your computer's hard disk. By default, samples and a Readme file are copied to a folder under \Program Files\Visual Studio 9\Samples\. For Visual Studio Express Editions, all samples are located on the Internet.

To run this sample

  • Press F5.

Demonstrates

This sample demonstrates creating XML comments, viewing them in the editor, and accessing them programmatically.

The Automobile class defines the following type elements, each of which demonstrates a different aspect of XML comments:

  • Types   Automobile and EngineOption

  • Properties   Model

  • Methods   Constructors, Upgrade, CalculateMaxTowing, WillItTow

  • Events   NeedsTuneUp

  • Delegates   RotateTires, ReplaceSparkPlugs

  • Fields   car, modelValue

The Click event handler for the Create Car button calls several of the Automobile members. When using IntelliSense in the Code Editor, the XML comments are displayed as ToolTips.

The Click event handler for the List Summaries button uses the XmlDocument class to query the XML file that contains the XML comments. When the project is compiled, this XML file is created and stored with the project assembly. The Compile tab of the Project Designer enables you to specify the location and name of this file.