<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.
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 Examinador 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.
// 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()
{
}
}
Referencia
Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)
Conceptos
Guía de programación de C#