<exception> (C#-Programmierhandbuch)

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

Parameter

  • cref = "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.

    Weitere Informationen zum Erstellen von cref-Verweisen auf einen generischen Typ finden Sie unter <see> (C#-Programmierhandbuch).

  • description
    Eine Beschreibung der Ausnahme.

Hinweise

Mit dem <exception>-Tag können Sie festlegen, welche Ausnahmen ausgelöst werden können. Dieses Tag kann für Definitionen für Methoden, Eigenschaften, Ereignisse und Indexer übernommen werden.

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

Weitere Informationen zur Behandlung von Ausnahmen finden Sie unter Ausnahmen und Ausnahmebehandlung (C#-Programmierhandbuch).

Beispiel

// compile with: /doc:DocFileName.xml 

/// Comment for class
public class EClass : System.Exception
{
    // class definition...
}

/// Comment for class
class TestClass
{
    /// <exception cref="System.Exception">Thrown when...</exception>
    public void DoSomething()
    {
        try
        {
        }
        catch (EClass)
        {
        }
    }
}

Siehe auch

Referenz

Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)

Konzepte

C#-Programmierhandbuch