@param Tag

Adds a parameter description to the parameters section. A VBdocman comment may contain any number of @param tags.

Syntax

@param parameter-name description

The description may be continued on the next line. This tag is used in a method, function, property or event comment when some arguments are used.

Example:

'** 
'Decides the next turn of player. 
'
'@param x Required. Integer. X position    of cell. 
'@param y Required. Integer. Y position of cell. 
Public Sub decide(x As Integer, y As Integer)
End Sub

The text in bold is added automatically when using Add VBdocman from pop-up menu.


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