Compartilhar via


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

<summary>description</summary>

Parâmetros

  • description
    Um resumo do objeto.

Comentários

A marca <resumo>deve ser usada para descrever um tipo ou um membro de tipo.Use <remarks> para adicionar informações complementares a uma descrição do tipo.

O texto da marca <resumo>é a única fonte de informações sobre o tipo no IntelliSense e também é exibido naPesquisador de Objetos.

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.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </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)