<paramref> (Guia de Programação em C#)

<paramref name="name"/>

Parâmetros

• name
  O nome do parâmetro para se referir a ele. Envolva o nome em aspas duplas (" ").

Comentários

O <paramref> marca oferece uma maneira para indicar que uma palavra no código comentários, por exemplo em <summary> ou <remarks> bloco refere-se a um parâmetro. O arquivo XML pode ser processado para formatar essa palavra de alguma maneira distinta, como com uma fonte em negrito ou itálico.

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
{
    /// <summary>DoWork is a method in the TestClass class.   
    /// The <paramref name="Int1"/> parameter takes a number.
    /// </summary> 
    public static void DoWork(int Int1)
    {
    }

    /// text for Main 
    static void Main()
    {
    }
}

Consulte também

Referência

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

Conceitos

Guia de Programação em C#