VSdocman works fine without any additional comment. All Methods, Properties, Events and other links are generated properly and parameters description tables and other fields are also included. But the user is then forced to add some additional information into these fields (describe parameters, add See Also, Exceptions links, examples and others) later. And it must be done every time when the new documentation is generated. To avoid that you can include that information directly into source code. It is done by adding special comments which VSdocman understands. VSdocman understands two types of comments:
Commenting is based on tags that are included in your comments. XML tags have standard XML syntax. XML comments have prefix which can be defined by user, default is ''' for VB and /// for C#. For example
XML comments are described here in detail. If you wish to add comments manually, the best way to learn them is to use Comment editor first. |
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:
 Example of automatically added default comment
 Example of VSdocman Comment Editor
 Automatically added Description attribute |
