<returns> (Visual Basic)

  • Artykuł

Określa zwróconą wartość właściwości lub funkcji.

<returns>description</returns>

Parametry

  • description
    Opis wartości zwracanej.

Uwagi

Użyj <returns> tag komentarza w deklaracji metody do opisania wartości zwracanej.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

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

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

Informacje

Zalecane tagi XML dla komentarzy dokumentacji (Visual Basic)