How to: Create XML Documentation in Visual Basic
Visual Studio 2005
This example shows how to add XML documentation comments to your code.
To create XML documentation for a type or member
-
In the Code Editor, position your cursor on the line above the type or member for which you want to create documentation.
-
Type ''' (three single-quotation marks).
An XML skeleton for the type or member is added in the Code Editor.
-
Add descriptive information between the appropriate tags.
Note If you add additional lines within the XML documentation block, each line must begin with '''.
-
Add additional code that uses the type or member with the new XML documentation comments.
IntelliSense displays the text from the <summary> tag for the type or member.
-
Compile the code to generate an XML file containing the documentation comments. For more information, see /doc.
