Partager via

<exception> (guide de programmation C#)

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

Paramètres

  • cref = "member"
    Référence à une exception disponible dans l'environnement de compilation en cours. Le compilateur vérifie que l'exception donnée existe et traduit member dans le nom d'élément canonique dans le code XML de sortie. member doit apparaître dans des guillemets doubles (" ").

    Pour plus d'informations sur la création d'une référence cref à un type générique, consultez <see> (Guide de programmation C#).

  • description
    Description de l'exception.

Notes

La balise <exception> permet de spécifier les exceptions qui peuvent être levées. Cette balise peut être appliquée aux définitions des méthodes, propriétés, événements et indexeurs.

Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.

Pour plus d'informations sur la gestion des exceptions, consultez Exceptions et gestion des exceptions (Guide de programmation C#).

Exemple

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

Voir aussi

Référence

Balises recommandées pour commentaires de documentation (Guide de programmation C#)

Concepts

Guide de programmation C#