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

Actualización: noviembre 2007

<param name='name'>description</param>

Parámetros

• name
  Nombre de un parámetro de método. Ponga el nombre entre comillas dobles (" ").

• description
  Descripción del parámetro.

Comentarios

La etiqueta <param> se debe utilizar en el comentario de una declaración de método para describir uno de los parámetros del método.

El texto para la etiqueta <param> se mostrará en IntelliSense, el Explorador de objetos y en el Informe Web de comentario de código.

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
{
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }
    /// 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#)