Compartilhar via


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

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

Parâmetros

  • term
    Um termo de definir, será definido em description.

  • description
    Em um item em um marcador ou lista numerada ou a definição de um term.

Comentários

O bloco <listheader>é usado para definir a linha de título de uma tabela ou uma definição de lista.Ao definir uma tabela, você precisará fornecer uma entrada do termo no título.

Cada item da lista é especificada com um bloco <item>.Ao criar uma lista de definições, você precisará especificar os dois term e description. No entanto, para uma tabela, lista com marcadores ou lista numerada, você só precisa fornecer uma entrada para description.

Uma lista ou tabela pode ter tantos blocos <item>conforme necessário.

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>Here is an example of a bulleted list:
    /// <list type="bullet">
    /// <item>
    /// <description>Item 1.</description>
    /// </item>
    /// <item>
    /// <description>Item 2.</description>
    /// </item>
    /// </list>
    /// </summary>
    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)