Newsletter

Sign up for our free newsletter. Your email address will only be used to send out the newsletter.


RSS Feeds

Product news

Home arrow Products arrow VBdocman arrow On-line Help arrow Commenting the Code

Adding VBdocman Comments
VBdocman works fine without any additional comment. All Applies to, Methods, Properties and Events 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, Examples links 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 VBdocman understands. This is classical VB comment with some additional features. (It is very similar to JavaDoc @-style comment).

Example:

'**
'Clears the playing field.
'
'@rem All cells are set to 0.
'@return Boolean. True if succesful.
'@see .setCell
Public Function clear() As Boolean
End Sub

Automatic Addition of Comment

User can write all that comment manually but he is not required to do so. VBdocman can do that automatically.

When user clicks right mouse button on the code window, the pop-up menu appears. Menu contains Add VBdocman Comment and Comment Editor items which perform the following actions:

  1. Add VBdocman Comment automatically adds the default comment to the object over which there is a cursor.

    Adding default customizable JavaDoc comment

     

  2. Comment Editor invokes the Comment editor for selected object. This is useful when creating complicated documentation including cross-references, parameters settings and others. Comment editor provides the user-friendly graphical way for editing the comments.

    JavaDoc comment editor for VB6
 
 
© Copyright 2008 Helixoft All rights reserved. | Privacy Statement