<exception> (Guida per programmatori C#)

Articolo
09/12/2008

Aggiornamento: novembre 2007

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

Parametri

cref = "member"
Riferimento a un'eccezione disponibile dall'ambiente di compilazione corrente. Il compilatore verifica l'esistenza dell'eccezione specificata e converte member nel nome canonico dell'elemento nel file XML di output. member deve essere racchiuso tra virgolette doppie (" ").

Per ulteriori informazioni sulla creazione di un riferimento cref a un tipo generico, vedere <see> (Guida per programmatori C#).
description
Descrizione dell'eccezione.

Note

Il tag <exception> consente di specificare le eccezioni che possono essere generate Questo tag può essere applicato alle definizioni di metodi, proprietà, eventi e indicizzatori.

Eseguire la compilazione con /doc per elaborare in un file i commenti per la creazione della documentazione.

Esempio

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

Vedere anche

Concetti

Guida per programmatori C#

Riferimenti

Tag consigliati per i commenti relativi alla documentazione (Guida per programmatori C#)

Condividi tramite