<param> (Guia de programação C#)
<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
O <param> marca deve ser usada no comentário para uma declaração de método para descrever um dos parâmetros do método.Para documentar os vários parâmetros, use vários <param> marcas de formatação.
O texto para <param> marca será exibida no IntelliSense, o Pesquisador de objetos e no relatório da Web de comentário de código.
Compilar com /doc a comentários de documentação do processo para um arquivo.
Exemplo
// compile with: /doc:DocFileName.xml
/// text for class TestClass
public class TestClass
{
// Single parameter.
/// <param name="Int1">Used to indicate status.</param>
public static void DoWork(int Int1)
{
}
// Multiple parameters.
/// <param name="Int1">Used to indicate status.</param>
/// <param name="Float1">Used to specify context.</param>
public static void DoWork(int Int1, float Float1)
{
}
/// text for Main
static void Main()
{
}
}
Consulte também
Referência
Marcas recomendadas para comentários da documentação (C# Guia de programação)