Partilhar via


<typeparam> (Guia de programação C#)

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

Parâmetros

  • name
    Nome do parâmetro de tipo.Envolva o nome em aspas duplas (" ").

  • description
    Uma descrição para o parâmetro de tipo.

Comentários

O <typeparam> marca deve ser usada no comentário para uma declaração de tipo ou método genérico para descrever um parâmetro de tipo.Adicione uma marca para cada parâmetro do tipo do tipo genérico ou método.

Para obter mais informações, consulte Genéricos (guia de programação do C#).

O texto para o <typeparam> marca será exibida no IntelliSense, o Object Browser Window código de relatório da web de comentário.

Compilar com /doc a comentários de documentação do processo para um arquivo.

Exemplo

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

Consulte também

Referência

Marcas recomendadas para comentários da documentação (C# Guia de programação)

Conceitos

Guia de programação do C#

Outros recursos

Referência de C#