VSdocman can generate the documentation even without any additional comments in the source code. All Methods, Properties, Events and other links are generated properly and parameters descriptions and other sections are also included.
However, it is good to include additional descriptions directly into source code. It is done by adding standard XML comments which VSdocman understands in both C# and VB .NET (even in 2002 and 2003 versions). For historical reasons and for smooth migration from VB6 to VB .NET, VSdocman also recognizes old Javadoc comments in VB .NET code.
Commenting is based on tags that are included in your comments.
'''<summary>This is my method.</summary>
'''<remarks>This is remarks section</remarks>
Automatic Addition of Comment
User can write all that comment manually but he is not required to do so. VSdocman can do that automatically.VSdocman has intelligent mechanism for inserting comments. Depending on code element name or type, you can easily insert predefined default comment. For example, the "Gets or sets a value indicating whether ..." summary text is automatically generated for boolean properties. This is controlled by comment templates which are fully customizable by user. There are some predefined templates for the most common cases.
When user clicks right mouse button on the code window, the pop-up menu appears. Menu contains Add XML Comment, Comment Editor and Add Description Attribute items which perform the following actions:
- Add XML Comment automatically adds the default XML comment to the current member. User can preset how the default comment should look like.
- Comment Editor invokes the WYSIWYG Comment editor for selected member. This is useful when creating complicated documentation including cross-references, pictures, tables and others. Comment editor provides the user-friendly graphical way for editing the comments.
- Add Description Attribute automatically adds the Description attribute to the current member. Short property description in Properties Window must be defined with System.ComponentModel.Description attribute.