VSdocman Comment Editor is a WYSIWYG tool for editing XML comments. Editor recognizes both XML and @-style comments but it can only produce XML comments. VSdocman comments can be edited directly in the source code but sometimes this can be a difficult task. For example using <set> or <seealso> tags can lead to errors. Even with simple comments it is not comfortable to update them when something has changed.

Comment editor can significantly help in documentation process. It allows to edit comments without any knowledge of XML tags and it assures consistency with actual source code state as well. With comment editor, user can easily edit all fields in comment, automatically update changed parameters of methods and their settings, select available cross-references from a list and so on.

Editor reads your comments and at the end (by pressing OK or Apply button) it writes the changes back into source code comments. Thus you can combine manual and graphical comment editing as you want. Comment editor always produces correct output and it may reorder your tags written manually. This however, does not affect the final documentation. If the Comment editor is invoked on member without VSdocman comment, it is automatically filled by default VSdocman comment for that object.

To invoke Comment Editor

In the code window select the object you want to document. Click right mouse button, the pop-up menu appears. Press Comment Editor item to start Comment editor.

 

 

You can switch between WYSIWYG view and classical view with WYSIWYG button.

For more details see the following topics about comment editor:

WYSIWYG
Advanced
General
Parameters
References
Example
Misc
User-defined fields
Source code view

See Also

Comment Editor - WYSIWYG | Comment Editor - General | Comment Editor - Parameters | Comment Editor - References | Comment Editor - Example | Comment Editor - Misc | Comment Editor - User fields | Comment Editor - Source code view