Freigeben über

<list> (C#-Programmierhandbuch)

  • Artikel

Aktualisiert: November 2007

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

Parameter

  • term
    Ein zu definierender Term, der in description definiert wird.

  • description
    ein Element in einer Aufzählung oder nummerierten Liste oder die Definition eines terms.

Hinweise

Der <listheader>-Block wird zur Definition der Überschriftenzeile einer Tabelle oder einer Definitionsliste verwendet. Wenn eine Tabelle definiert wird, muss nur ein Eintrag für "term" in der Überschrift angegeben werden.

Jedes Element der Liste wird mit einem <item>-Block angegeben. Beim Erstellen einer Definitionsliste müssen Sie sowohl term als auch description angeben. Für eine Tabelle, eine Aufzählung oder eine nummerierte Liste muss jedoch nur ein Eintrag für description angegeben werden.

Eine Liste oder Tabelle kann so viele <item>-Blöcke enthalten, wie benötigt werden.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit "/doc" kompiliert werden.

Beispiel

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

Konzepte

C#-Programmierhandbuch

Referenz

Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)