<list> (Guia de programação C#)

Artigo
08/04/2011

<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 para definir, o qual será definido em description.
description
Tanto um item em um marcador ou lista numerada ou a definição de um term.

Comentários

<listheader> bloco é usado para definir a linha de cabeçalho de uma tabela ou uma definição de lista. Ao definir uma tabela, você só precisa fornecer uma entrada para o termo no título.

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

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

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

Referência

Conceitos

C# Programming Guide

Compartilhar via