Edit

Share via

<returns> (Visual Basic)

  • Article

Specifies the return value of the property or function.

Syntax

<returns>description</returns>

Parameters

description
A description of the return value.

Remarks

Use the <returns> tag in the comment for a method declaration to describe the return value.

Compile with -doc to process documentation comments to a file.

Example

This example uses the <returns> tag to explain what the DoesRecordExist function returns.

''' <param name="id">The ID of the record to update.</param>
''' <remarks>Updates the record <paramref name="id"/>.
''' <para>Use <see cref="DoesRecordExist"/> to verify that
''' the record exists before calling this method.</para>
''' </remarks>
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here.
End Sub
''' <param name="id">The ID of the record to check.</param>
''' <returns><c>True</c> if <paramref name="id"/> exists,
''' <c>False</c> otherwise.</returns>
''' <remarks><seealso cref="UpdateRecord"/></remarks>
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
    ' Code goes here.
End Function

See also