<summary> (C#-Programmierhandbuch)

  • Artikel

Aktualisiert: November 2007

<summary>description</summary>

Parameter

  • description
    eine Zusammenfassung des Objekts.

Hinweise

Das <summary>-Tag sollte verwendet werden, um einen Typ oder einen Typmember zu beschreiben. Mit <remarks> können Sie zusätzliche Informationen zu einer Typbeschreibung angeben.

Der Text für das <summary>-Tag ist die einzige Informationsquelle über den Typ in IntelliSense und wird auch im Objektbrowser angezeigt.

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>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

Siehe auch

Konzepte

C#-Programmierhandbuch

Referenz

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