<list> (C# -Programmierhandbuch)<list> (C# Programming Guide)

SyntaxSyntax

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

ParameterParameters

term
Ein zu definierender Begriff, der in description definiert wird.A term to define, which will be defined in description.

description
Entweder ein Element einer Aufzählung oder nummerierten Liste oder die Definition eines term.Either an item in a bullet or numbered list or the definition of a term.

HinweiseRemarks

Der <listheader>-Block wird verwendet, um die Überschriftenzeile einer Tabelle oder einer Definitionsliste zu definieren.The <listheader> block is used to define the heading row of either a table or definition list. Bei der Definition einer Tabelle müssen Sie nur einen Eintrag für „term“ in der Überschrift angeben.When defining a table, you only need to supply an entry for term in the heading.

Jedes Element der Liste wird mit einem <item>-Block angegeben.Each item in the list is specified with an <item> block. Beim Erstellen einer Definitionsliste müssen Sie sowohl term als auch description angeben.When creating a definition list, you will need to specify both term and description. Für eine Tabelle, eine Auflistung oder eine nummerierte Liste muss jedoch nur ein Eintrag für description angegeben werden.However, for a table, bulleted list, or numbered list, you only need to supply an entry for description.

Eine Liste oder Tabelle kann so viele <item>-Blöcke besitzen wie nötig.A list or table can have as many <item> blocks as needed.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.Compile with /doc to process documentation comments to a file.

BeispielExample

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

Siehe auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
Empfohlene Tags für DokumentationskommentareRecommended Tags for Documentation Comments