Partager via

<example> (Guide de programmation C#)

  • Article

Mise à jour : novembre 2007

<example>description</example>

Paramètres

  • description
    Description de l'exemple de code.

Notes

La balise <example> vous permet de spécifier un exemple d'utilisation d'une méthode ou de tout autre membre de bibliothèque. Cela implique généralement l'utilisation de la balise <code>.

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

Exemple

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>
    /// The GetZero method.
    /// </summary>
    /// <example> This sample shows how to call the GetZero method.
    /// <code>
    /// class TestClass 
    /// {
    ///     static int Main() 
    ///     {
    ///         return GetZero();
    ///     }
    /// }
    /// </code>
    /// </example>
    public static int GetZero()
    {
        return 0;
    }

    /// text for Main
    static void Main()
    {
    }
}

Voir aussi

Concepts

Guide de programmation C#

Référence

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