Share via


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

<typeparam name="name">description</typeparam>

Parámetros

  • name
    Nombre del parámetro de tipo. Ponga el nombre entre comillas dobles (" ").

  • description
    Descripción del parámetro de tipo.

Comentarios

La etiqueta <typeparam> se debería utilizar en el comentario de una declaración de tipo o método genérico para describir un parámetro de tipo. Agregue una etiqueta para cada parámetro de tipo del tipo o método genérico.

Para obtener más información, vea Genéricos (Guía de programación de C#).

El texto de la etiqueta <typeparam> se mostrará en IntelliSense, el informe web de comentario de código de Examinador de objetos.

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 

/// comment for class
public class TestClass
{
    /// <summary>
    /// Creates a new array of arbitrary type <typeparamref name="T"/>
    /// </summary>
    /// <typeparam name="T">The element type of the array</typeparam>
    public static T[] mkArray<T>(int n)
    {
        return new T[n];
    }
}

Vea también

Referencia

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

Conceptos

Guía de programación de C#

Otros recursos

Referencia de C#