Condividi tramite

<exception> (Guida per programmatori C#)

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

Parametri

  • cref = "member"
    Riferimento a un'eccezione disponibile dall'ambiente di compilazione corrente. Il compilatore verifica che l'eccezione specificata esiste e converte member nel nome canonico dell'elemento nell'XML di output. Il parametro member deve essere visualizzato 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.

Per ulteriori informazioni sulla gestione delle eccezioni, vedere Eccezioni e gestione delle eccezioni (Guida per programmatori C#).

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

Riferimenti

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

Concetti

Guida per programmatori C#