<remarks> (C#-Programmierhandbuch)

  • Artikel

Aktualisiert: November 2007

<remarks>description</remarks>

Parameter

  • Description
    eine Beschreibung des Members.

Hinweise

Mittels des <remarks>-Tags werden Informationen über einen Typ hinzugefügt. Diese dienen als Ergänzung zu den mit <summary> angegebenen Informationen. Diese Informationen werden im Objektbrowser angezeigt.

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

Beispiel

// compile with: /doc:DocFileName.xml 

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public class TestClass
{
    /// text for Main
    static void Main()
    {
    }
}

Siehe auch

Konzepte

C#-Programmierhandbuch

Referenz

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