@user1, @user2, @user3, @user4, @user5 Tags

User defined tags. The names @user1, @user2, @user3, @user4, @user5 are their default names and can be changed by the user. They can be used for any purpose and their syntax and usage is the same as e.g. @rem tag. The user can define up to 5 own tags.

If they are used, the templates have to be edited by user, so that new tags (their fields) were shown in the resulting documentation. Usually it is sufficient to change existing templates which support user-defined tags. Installation of VBdocman comes with such templates and their names have the form *_usertags.vbdt. User defined fields have the same format as Remarks and are located under Remarks. The only thing that has to be changed is the name of user-defined field. If user-defined tag 1 is @copyright, then the name of corresponding field should be Copyright or something like this. Default names for them are:

User-defined field 1
User-defined field 2
User-defined field 3
User-defined field 4
User-defined field 5

Those names are defined in templates in following macros:

$user-field1-name$ User-defined field 1
$user-field2-name$ User-defined field 2
$user-field3-name$ User-defined field 3
$user-field4-name$ User-defined field 4
$user-field5-name$ User-defined field 5

To change it, find a part of code above in the template you want to use and change the values. In our case:

$user-field1-name$ Copyright

 

Syntax

@user1 description

The description may be continued on the next line.

Example:

'**
'Returns score for specified turn.
'
'@copyright My company 2001
Public Function evaluateTurn(ByVal x As Integer, ByVal y As Integer) As Integer
End Function. 


See also Templates and Macro Language.


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