Compartilhar via


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

<paramref name="name"/>

Parâmetros

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

Comentários

A marca <paramref>oferece um meio para indicar que uma palavra em comentários do código, por exemplo, em um <resumo>ou <remarks>Bloquear faz referência a um parâmetro.O arquivo XML pode ser processado para esta palavra de alguma maneira distinta, sistema autônomo com uma fonte em negrito ou itálico.

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
{
    /// <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

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)