Partager via

<remarks> (Visual Basic)

  • Article

Mise à jour : novembre 2007

Spécifie une section Notes pour le membre.

<remarks>description</remarks>

Paramètres

  • description
    Description du membre.

Notes

La balise <remarks> permet d'ajouter des informations sur un type et de compléter les informations spécifiées par <summary> (Visual Basic). Ces informations sont affichées dans l'Explorateur d'objets.

Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.

Exemple

Cet exemple utilise la balise <remarks> pour expliquer le rôle de la méthode UpdateRecord 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)