<exception> (C#-Programmierhandbuch)

Syntax

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

Parameter

cref = " member"
Ein Verweis auf eine Ausnahme, die von der aktuellen Kompilierungsumgebung verfügbar ist. Der Compiler prüft, ob die angegebene Ausnahme vorhanden ist, und übersetzt in der Ausgabe-XML member in den kanonischen Elementnamen. member muss in doppelte Anführungszeichen (" ") gesetzt werden.

Weitere Informationen zum Erstellen von cref-Verweisen auf einen generischen Typ finden Sie unter <see.

description
Eine Beschreibung der Ausnahme.

Hinweise

Mit dem Tag <exception> können Sie angeben, welche Ausnahmen ausgelöst werden können. Dieses Tag kann für Definitionen für Methoden, Eigenschaften, Ereignisse und Indexer angewendet 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.

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

C#-Programmierhandbuch
Empfohlene Tags für Dokumentationskommentare