Partager via

<exception> (Guide de programmation C#)

  • Article

Mise à jour : novembre 2007

<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 par le nom d'élément complet dans la sortie XML. member doit être placé entre 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.

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

Concepts

Guide de programmation C#

Référence

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