
286
|
Chapter 8, Comments and Documentation
#70 Create XML Comments with VB.NET
HACK
Using VBCommenter
Once installed, VBCommenter lets you create XML comments by using
three apostrophes, much as C# comments use three slashes for XML com-
ments. To create a block of XML comments above a function or class, type
three apostrophes and then press Enter. Here is a sample XML section cre-
ated for a generic sub:
''' ------------------------------------------------------------
''' Project : TestXMLLib
''' Class : Class1
'''
''' ------------------------------------------------------------
''' <summary>
''' This class contains a number of functions that we can call.
''' </summary>
''' <remarks>
''' </remarks>
''' <history>
''' [James Avery] 10/8/2004 Created
''' </history>
''' ------------------------------------------------------------
You can also create XML comments for classes:
''' ------------------------------------------------------------
''' <summary>
''' This sub goes and does something important.
''' Throws CannotPerformException if an error is encountered.
''' </summary>
''' <remarks>
''' </remarks>
''' <history>
''' [James Avery] 10/8/2004 Created
''' </history>
''' ------------------------------------------------------------
Using VBCommenter, you can create comments for any public type includ-
ing functions, properties, enumerations, and so on. When you compile your
application, the VBCommenter power toy will ...