Compartilhar via


<param>(Guia de programação translation from VPE for Csharp)

<param name='name'>description</param>

Parâmetros

  • name
    O nome do parâmetro de um método.Envolva o nome em aspas duplas (" ").

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

Comentários

A marca <param>deve ser usada no comentário para uma declaração de método para descrever um dos parâmetros do método.

O texto da marca <param>será exibido no IntelliSense, o Pesquisador de objetos e no relatório de Web comentário do código.

Compilar com /doc para processar documentação comentários em um arquivo.

Exemplo

// 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()
    {
    }
}

Consulte também

Conceitos

Guia de Programação C#

Referência

Recomendado Rótulos de comentários de documentação (guia de programação translation from VPE for Csharp)