Go to Tools - VSdocman menu or press VSdocman button on standard toolbar. VSdocman dialog appears, select Options pane. Set Comments - General page.

Comments that VSdocman recognizes

Select which comments are recognized by VSdocman.

Option

Description

None Comments

VSdocman ignores any comments.

XML comments

VSdocman only recognizes standard XML comments defined by Microsoft. Most of XML comment tags are supported. See also XML Documentation.

Old @-style comments

VSdocman only recognizes old and deprecated javadoc @-style comments.

Both types of comments

VSdocman recognizes both XML and @-style comments.

 

C# XML comment line prefix

Comment prefix for C#. To distinguish XML comments from standard comment you must use some unique prefix for XML comments. It must of course start with //. It is recommended to use ///.

VB XML comment line prefix

Comment prefix for Visual Basic. To distinguish XML comments from standard comment you must use some unique prefix for XML comments. It must of course start with quote. It is recommended to use three quotes '''.

Insert VSdocman XML comments instead of the VS default XML comments for /// or ''' key press

Indicates whether the built-in triple typed /// or ''' are intercepted by VSdocman's Add XML Comment from the context menu. When enabled, VSdocman XML comments are inserted instead of the default Visual Studio XML comments when you type /// or '''. This allows you to insert comments according to the comment templates, including inherited comments.

See Also