Partager via

<renvoie> (Visual Basic)

  • Article

Spécifie la valeur de retour de la propriété ou de la fonction.

Syntaxe

<returns>description</returns>

Paramètres

description
Description de la valeur de retour.

Notes

La balise <returns> doit être utilisée dans le commentaire relatif à une déclaration de méthode pour décrire la valeur renvoyée.

Compilez avec -doc pour placer les commentaires de documentation dans un fichier en vue de les traiter.

Exemple

Cet exemple utilise la balise <returns> pour expliquer ce que retourne la fonction DoesRecordExist.

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

Voir aussi