Compartilhar via


<example>(Guia de programação translation from VPE for Csharp)

<example>description</example>

Parâmetros

  • description
    Uma descrição do código de exemplo.

Comentários

A marca <example>permite que você especificar um exemplo de como usar um método ou Outros membro da biblioteca.Isso normalmente envolve o uso a <code> marca.

Compilar com /doc para processar documentação comentários em um arquivo.

Exemplo

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

Consulte também

Conceitos

Guia de Programação C#

Referência

Recomendado Rótulos de comentários de documentação (guia de programação translation from VPE for Csharp)