<exception> (C#-Programmierhandbuch)<exception> (C# Programming Guide)

SyntaxSyntax

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

ParameterParameters

cref = " member"cref = " member"
Ein Verweis auf eine Ausnahme, die von der aktuellen Kompilierungsumgebung verfügbar ist.A reference to an exception that is available from the current compilation environment. Der Compiler prüft, ob die angegebene Ausnahme vorhanden ist, und übersetzt in der Ausgabe-XML member in den kanonischen Elementnamen.The compiler checks that the given exception exists and translates member to the canonical element name in the output XML. member muss in doppelte Anführungszeichen (" ") gesetzt werden.member must appear within double quotation marks (" ").

Weitere Informationen zum Erstellen von cref-Verweisen auf einen generischen Typ finden Sie unter <see.For more information on how to create a cref reference to a generic type, see <see>.

description
Eine Beschreibung der Ausnahme.A description of the exception.

HinweiseRemarks

Mit dem Tag <exception> können Sie angeben, welche Ausnahmen ausgelöst werden können.The <exception> tag lets you specify which exceptions can be thrown. Dieses Tag kann für Definitionen für Methoden, Eigenschaften, Ereignisse und Indexer angewendet werden.This tag can be applied to definitions for methods, properties, events, and indexers.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.Compile with /doc to process documentation comments to a file.

Weitere Informationen zur Behandlung von Ausnahmen finden Sie unter Ausnahmen und Ausnahmebehandlung.For more information about exception handling, see Exceptions and Exception Handling.

BeispielExample

// 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 auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
Empfohlene Tags für DokumentationskommentareRecommended Tags for Documentation Comments