<exception> (Visual Basic)

Spécifie les exceptions pouvant être levées.

Syntaxe

<exception cref="member">description</exception>  

Paramètres

member
Référence à une exception qui est disponible à partir de l’environnement de compilation actuel. Le compilateur vérifie que l’exception donnée existe, et il traduit member en nom d’élément canonique dans le fichier XML de sortie. member doit apparaître entre guillemets doubles (" ").

description
Une description.

Notes

Utilisez la balise <exception> pour spécifier quelles exceptions peuvent être levées. Cette balise est appliquée à une définition de méthode.

Compilez avec -doc pour placer les commentaires de documentation dans un fichier en vue de les traiter.

Exemple

Cet exemple utilise la balise <exception> pour décrire une exception que la fonction IntDivide peut lever.

''' <exception cref="System.OverflowException">
''' Thrown when <paramref name="denominator"/><c> = 0</c>.
''' </exception>
Public Function IntDivide(
        ByVal numerator As Integer,
        ByVal denominator As Integer
) As Integer
    Return numerator \ denominator
End Function

Voir aussi

• Étiquettes XML pour les commentaires