VSdocman provides a mechanism for developers to document their code using @-style javadoc comments. This is however old way and we recommend to use XML comments.
@-style comment is classical VB comment with some additional features. (It is very similar to JavaDoc comment):
The first line must be '**
VSdocman @-style comment block ends with first non comment line.
VSdocman comment block must be located immediately before commented object (method, function, property, event, ...), only empty lines are allowed between them. If there is some other line between them (usual VB comment), then VSdocman comment block is ignored.
'** 'This is good @-style 'comment. Public Sub myMethod() End Sub '** 'This is not good @-style comment because it 'is not immediately before declaration. 'dummy comment Public Sub myMethod() End Sub
@-style comment blocks placed in the body of an object are ignored. Only one @-style comment block per object declaration statement is recognized. Note, if there are more variables or constants in one line, all of them appear in documentation, but their descriptions may be invalid.
A comment is a description followed by tags. The description begins after the starting delimiter '** and continues until the tag section. The tag section starts with the first character @ that begins a line (ignoring leading quote). The description cannot continue after the tag section begins. There can be any number of tags -- some types of tags can be repeated while others cannot. This @see starts the tag section:
'** 'This is description of my method. ' '@see .myProperty '@see .myMethod2 '@rem This is remarks section. Public Sub myMethod() End Sub
Leading quotes. When VSdocman parses a @-style comment, leading quote (') characters on each line are discarded; blanks and tabs preceding the initial quote (') characters are also discarded. Everything after that quote including leading white space is being left, such as when indenting sample code.