<list> (Przewodnik programowania w języku C#)

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

Parametry

• term
  Termin do definiowania, które zostaną określone w description.

• description
  Albo element w punktor lub listy numerowanej lub definicji term.

Uwagi

<listheader> blok jest używany do definiowania wiersza nagłówka tabeli lub definicji listy.Podczas definiowania tabeli, wystarczy dostaw wpis na określenie w nagłówku.

Każdy element na liście jest określany za pomocą <item> blok.Podczas tworzenia listy definicji, musisz określić zarówno term i description.Jednakże dla tabeli, listy punktowanej lub numerowanej listy, trzeba tylko wpis dla dostawy description.

Listę lub tabelę można mieć tyle <item> bloki w razie potrzeby.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

// 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()
    {
    }
}

Zobacz też

Informacje

Znaczniki zalecane dla komentarzy do dokumentacji (Przewodnik programowania w języku C#)

Koncepcje

Przewodnik programowania w języku C#