Describes the return value. Equivalent XML tag is <returns>.

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:

    '**

    'Our sample method.

    '@return       True if no error occurs.

    Function method1(ByVal x As Integer) As Boolean

See Also

<returns> tag