<zwraca> (Visual Basic)

Określa wartość zwracaną właściwości lub funkcji.

Składnia

<returns>description</returns>  

Parametry

description
Opis wartości zwracanej.

Uwagi

Użyj tagu <returns> w komentarzu dla deklaracji metody, aby opisać wartość zwracaną.

Skompiluj za pomocą -doc , aby przetworzyć komentarze dokumentacji do pliku.

Przykład

W tym przykładzie użyto tagu <returns> , aby wyjaśnić, co DoesRecordExist zwraca funkcja.

''' <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

Zobacz także

• Tagi komentarzy XML