<remarques> (Visual Basic)
Spécifie une section de remarques pour le membre.
Syntaxe
<remarks>description</remarks>
Paramètres
description
Description du membre.
Notes
Utilisez la balise <remarks>
pour ajouter des informations sur un type en complétant les informations spécifiées par <summary>.
Ces informations s’affichent dans l’Explorateur d’objets. Pour plus d’informations sur l’Explorateur d’objets, consultez Affichage de la structure du code.
Compilez avec -doc pour placer les commentaires de documentation dans un fichier en vue de les traiter.
Exemple
Cet exemple utilise la balise <remarks>
pour expliquer ce que fait la méthode UpdateRecord
.
''' <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
Collaborer avec nous sur GitHub
La source de ce contenu se trouve sur GitHub, où vous pouvez également créer et examiner les problèmes et les demandes de tirage. Pour plus d’informations, consultez notre guide du contributeur.