<example> (Guida per programmatori C#)

Aggiornamento: novembre 2007

<example>description</example>

Parametri

• description
  Descrizione dell'esempio di codice.

Note

Il tag <example> consente di specificare un esempio relativo all'utilizzo di un metodo o di un altro membro della libreria. Questa operazione implica, in genere, l'utilizzo del tag <code>.

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

Esempio

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

Vedere anche

Concetti

Guida per programmatori C#

Riferimenti

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