@return Tag

Describes the return value.

Syntax

@return description

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

Example:

'** 
'Returns score for specified turn.
'
'@return       Integer. Score of turn.
Public Function evaluateTurn(ByVal x As Integer, ByVal y As Integer) As Integer
End Function

The sections in bold are added automatically when using Add VBdocman from pop-up menu.


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