<summary> (Visual Basic)

  • Article

Spécifie le résumé du membre.

<summary>description</summary>

Paramètres

  • description
    Résumé de l'objet.

Notes

Utilisez les balises <summary> pour décrire un type ou un membre de type.Utilisez <remarks> (Visual Basic) pour ajouter des informations complémentaires à une description de type.

Le texte de la balise d' <summary> est la seule source d'informations sur le type dans Intellisense, et 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 traiter les commentaires de documentation et les placer dans un fichier.

Exemple

Cet exemple utilise la balise <summary> pour décrire la méthode ResetCounter et la propriété Counter.

''' <summary>
''' Resets the value 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

Référence

Balises XML recommandées pour les commentaires de documentation (Visual Basic)