<example> (Guía de programación de C#)

Actualización: noviembre 2007

<example>description</example>

Parámetros

• description
  Descripción del ejemplo de código.

Comentarios

La etiqueta <example> permite especificar un ejemplo de cómo utilizar un método u otro miembro de una biblioteca. Generalmente, esto supone utilizar la etiqueta <code>.

Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.

Ejemplo

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

Vea también

Conceptos

Guía de programación de C#

Referencia

Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)