<exception> (Visual Basic)

  • Artikel

Gibt an, welche Ausnahmen ausgelöst werden können.

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

Parameter

  • member
    ein Verweis auf eine Ausnahme, die in der aktuellen Kompilierungsumgebung verfügbar ist. Der Compiler überprüft, ob die angegebene Ausnahme vorhanden ist, und übersetzt member in den in der XML-Ausgabe enthaltenen kanonischen Elementnamen. member muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

  • description
    eine Beschreibung.

Hinweise

Geben Sie mit dem <exception>-Tag an, welche Ausnahmen ausgelöst werden können. Dieses Tag wird auf eine Methodendefinition angewendet.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

In diesem Beispiel wird mit dem <exception>-Tag eine Ausnahme beschrieben, die von der IntDivide-Funktion ausgelöst werden kann.

''' <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

Siehe auch

Referenz

Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)