XML Comments Sample
This sample demonstrates the XML comment feature of Visual Basic.
To get samples and instructions for installing them
Do one or more of the following:
On the Help menu, click Samples.
The Readme displays information about samples.
Visit the Visual Studio 2008 Samples Web site. The most recent versions of samples are available there.
Locate samples on the computer on which Visual Studio is installed. By default, samples and a Readme file are installed in drive:\Program Files\Microsoft Visual Studio 9.0\Samples\lcid. For Express editions of Visual Studio, all samples are located online.
For more information, see Visual Studio Samples.
.gif "Security note") Security Note: |
|---|
This sample code is intended to illustrate a concept, and it shows only the code that is relevant to that concept. It may not meet the security requirements for a specific environment, and it should not be used exactly as shown. We recommend that you add security and error-handling code to make your projects more secure and robust. Microsoft provides this sample code "AS IS" with no warranties. |
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.