C# 5.0 kurz & gut

XML-Dokumentation

Ein Dokumentationskommentar ist ein Stück eingebettetes XML, das einen Typ oder einen Member dokumentiert. Ein Dokumentationskommentar steht direkt vor einer Deklaration des Typs oder Member und beginnt mit drei Schrägstrichen (Slashes):

/// <summary>Beendet eine laufende Abfrage.</summary>
public void Cancel() { ... }

Kommentare über mehrere Zeilen können entweder so geschrieben werden

/// <summary>
/// Beendet eine laufende Abfrage.
/// </summary>
public void Cancel() { ... }

oder so (beachten Sie das zusätzliche Sternchen am Anfang):

/**
    <summary> Beendet eine laufende Abfrage. </summary>
*/
public void Cancel() { ... }

Wenn Sie mit der Direktive /doc kompilieren, extrahiert der Compiler die Dokumentationskommentare und sammelt ...