<typeparam> (Guia de Programação em C#)<typeparam> (C# Programming Guide)

SintaxeSyntax

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

ParâmetrosParameters

name
O nome do parâmetro de tipo.The name of the type parameter. Coloque o nome entre aspas duplas (" ").Enclose the name in double quotation marks (" ").

description
Uma descrição do parâmetro de tipo.A description for the type parameter.

ComentáriosRemarks

A marca <typeparam> deve ser usada no comentário para um tipo genérico ou para uma declaração de método descrever um dos parâmetros de tipo.The <typeparam> tag should be used in the comment for a generic type or method declaration to describe a type parameter. Adicione uma marca para cada parâmetro de tipo do tipo ou do método genérico.Add a tag for each type parameter of the generic type or method.

Para obter mais informações, consulte Genéricos.For more information, see Generics.

O texto da marca <typeparam> será exibido no IntelliSense, o relatório Web de comentários sobre código da Janela do Pesquisador de Objetos.The text for the <typeparam> tag will be displayed in IntelliSense, the Object Browser Window code comment web report.

Compile com -doc para processar comentários de documentação em um arquivo.Compile with -doc to process documentation comments to a file.

ExemploExample

// 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];
    }
}

Veja tambémSee also