@same Tag

Tells the compiler to use comment from another source.

Syntax

@same reference

If somewhere in tag section of VBdocman comment @same tag appears, whole comment is ignored and comment of referenced object is used instead. It is useful when commenting several classes containing the same properties or methods. For example, let's have two classes C1 and C2. They both have size property with the same meaning. So only one documentation is required.

In C1 class:

'**
'Sets/returns the size of ....
Public Property Get size() As Integer
End Property

In C2 class:

'**
'@same C1.
Public Property Get size() As Integer
End Property

 

Compiler then generates only one entry in documentation for both size properties. So, Applies To list automatically contains two references: to C1 and to C2 as well. If there was some other class C3 with size property with its own comment (not using @same), separate documentation entry would be created for it with class name in parentheses appended to name. In our case it would be size (C3). Applies To list of that entry contains only the reference to C3 class.

See also reference format.


Send feedback to Helixoft
© 2000-2005 Helixoft. All rights reserved.