<returns> (Visual Basic)
Mise à jour : novembre 2007
Spécifie la valeur de retour de la propriété ou de la fonction.
<returns>description</returns>
Paramètres
- description
Description de la valeur retournée.
Notes
Utilisez la balise <returns> dans le commentaire pour une déclaration de méthode afin de décrire la valeur de retour.
Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.
Exemple
Cet exemple utilise la balise <returns> pour expliquer ce que la fonction DoesRecordExist retourne.
''' <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
Référence
Balises XML recommandées pour les commentaires de documentation (Visual Basic)