VSdocman Help  

Built-in Tags Options

Go to Add-Ins -> VSdocman menu or press VSdocman button on standard toolbar. Options dialog appears. Set Comment - Built-in Tags 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 which tags are added automatically. 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.

There is a list of available tags on this page. Check those which you want to be added.

Interesting Links

Note that if you check <seealso> option, VSdocman tries to find all interesting links for current member. That means that source code is parsed and all used classes or interfaces (whether as parameters or as local variables), implemented interfaces, implementing classes and so are added. This is very useful during design process but during compilation it can significantly prolong compilation time. This happens if you have many non-commented members and you checked Compile also non-commented members option. As mentioned above, VSdocman tries to find interesting links for all of them but this parsing is very time-consuming.

Therefore, if <seealso> option is checked and you start to compile documentation you will be asked whether you want to temporarily uncheck this option during compilation. There will be no prompt if you generate documentation from command line.

See Also

VSdocman Options