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.

Go to Add-Ins - VSdocman menu or press VSdocman button on standard toolbar. VSdocman dialog appears, select Options pane. Set Comment Templates page.

When the user clicks right mouse button on the code window, the pop-up menu appears. Menu contains Add XML Comment item which automatically adds the comment to selected member. User can preset how the default comment should look like. These options are also applied when creating comments with Comment editor. Moreover, if you checked Compile also non-commented members option, VSdocman temporarily creates default comments for all non-commented members during compilation using these settings.

Each code element type has its own template, e.g. methods, properties, etc. Moreover, you can define the templates for parameters. To edit the template, select code element type on the left and edit its template on the right.

See Also

Adding Comments | VSdocman Options | Editing Comment Template | Editing Comment Rule | Comment Template Macros