Partage via

<résumé> (Visual Basic)

  • Article

Spécifie le résumé du membre.

Syntaxe

<summary>description</summary>

Paramètres

description
Résumé de l’objet.

Notes

Utilisez la balise <summary> pour décrire un type ou un membre de type. Utilisez <remarks> pour ajouter des informations supplémentaires à une description de type.

Le texte de la balise <summary> est la seule source d’informations sur le type dans IntelliSense et il est également affiché 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 <summary> pour décrire la méthode ResetCounter et la propriété Counter.

''' <summary>
''' Resets the value of the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

Voir aussi