Compartilhar via


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

<returns>description</returns>

Parâmetros

  • description
    Uma descrição de valor de retorno.

Comentários

A marca <returns>deve ser usada no comentário para uma declaração de método para descrever o valor retornado.

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
{
    /// <returns>Returns zero.</returns>
    public static int GetZero()
    {
        return 0;
    }

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