<exception> (Przewodnik programowania w języku C#)

  • Artykuł
<exception cref="member">description</exception>

Parametry

  • cref = " member"
    Odniesienia do wyjątek, który jest dostępny z bieżącego środowiska kompilacji.Kompilator sprawdza, czy dany wyjątek istnieje i tłumaczy member do nazwy kanonicznej element danych wyjściowych XML.membermuszą się pojawiać w podwójny cudzysłów ("").

    Aby uzyskać więcej informacji na temat tworzenia cref odwołanie do typu rodzajowego, zobacz <see> (Przewodnik programowania w języku C#).

  • description
    Opis wyjątku.

Uwagi

<exception> tag pozwala określić wyjątki, które może zostać wygenerowany.Ten tag, mogą być stosowane do definicji metod, właściwości, zdarzenia i indeksatory.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Aby uzyskać więcej informacji na temat obsługi wyjątków, zobacz Wyjątki i obsługa wyjątków (Przewodnik programowania w języku C#).

Przykład

// 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)
        {
        }
    }
}

Zobacz też

Informacje

Znaczniki zalecane dla komentarzy do dokumentacji (Przewodnik programowania w języku C#)

Koncepcje

Przewodnik programowania w języku C#