Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

XML Comments Sample 

Download sample

This sample demonstrates the XML comment feature of Visual Basic.

Security noteSecurity Note

This sample code is provided to illustrate a concept and should not be used in applications or Web sites, as it may not illustrate the safest coding practices. Microsoft assumes no liability for incidental or consequential damages should the sample code be used for purposes other than as intended.

To open the sample file in Solution Explorer

  1. Click Download Sample.

    The File Download message box appears.

  2. Click Open, and on the left column of the zip folder window, click Extract all files.

    The Extraction Wizard opens.

  3. Click Next. You can change the directory that the files will be extracted to, and then click Next again.

  4. Make sure that the Show extracted files check box is selected, and click Finish.

  5. Double-click the sample's .sln file.

    The sample solution is displayed in Solution Explorer. You might get a security warning that says the solution location is not trusted. Click OK to continue.

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 allows you to specify the location and name of this file.

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft