<paramref> (Guía de programación de C#)
Actualización: noviembre 2007
<paramref name="name"/>
Parámetros
- name
Nombre del parámetro al que hay que hacer referencia. Ponga el nombre entre comillas dobles (" ").
Comentarios
La etiqueta <paramref> proporciona una forma de indicar que una palabra en los comentarios del código, por ejemplo en un bloque <summary> o <remarks>, hace referencia a un parámetro. El archivo XML se puede procesar para dar formato a esta palabra de alguna manera distinta, como con una fuente en negrita o en cursiva.
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>DoWork is a method in the TestClass class.
/// The <paramref name="Int1"/> parameter takes a number.
/// </summary>
public static void DoWork(int Int1)
{
}
/// text for Main
static void Main()
{
}
}
Vea también
Conceptos
Referencia
Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)