Meist werden Kommentare verwendet, um Methoden, Funktionen oder Klassen näher zu erläutern, also deren Funktionalität kurz zu dokumentieren. Dazu werden so genannte Dokumentationskommentare mit XML (EXtensible Markup Language) bereit gestellt.

Ein Kommentar wird z.B. unmittelbar über einer zu erläuternden Methode mit dem Trennzeichen /// eingeleitet. Daraufhin wird automatisch ein XML-Kommentarabschnitt erzeugt, in dem soweit in der Methode vorhanden, Kommentarzeilen für Parameter und Return-Werte vorgegeben werden. So kann der Quellcode durch wichtige Kommentare unkompliziert vervollständigt werden.

/// <summary>
/// Liefert ein Dataset zurück 
/// </summary>
/// <param name="name">Name</param>
/// <param name="Id">Id</param>
/// <param name="add">Adresse</param>
/// <param name="plz">PLZ</param>
/// <returns>Dataset</returns>
public Dataset Daten(string name, int Id, string add, int plz)
{
}

Folgende Tags werden am häufigsten verwendet:

• <c>
• <code>
• <example>
• <exception>
• <include>
• <list>
• <para>
• <param>
• <paramref>
• <remarks>
• <returns>
• <summary>
• <value>

Beispiel:

• Zusammenfassung
  für Dokumentationskommentare (Tags)
• Generierte Dokumentationsdatei

Dieser Eintrag wurde am Sonntag, 03. Dezember 2006 um 22:03 erstellt und ist abgelegt unter C#.