XML-Dokumentationskommentare in C# 👍 👎

Zwar nutzt sicherlich jeder sehr gerne die von Visual Studio eingeblendeten Kommentare während der Entwicklung mit dem .NET-Framework, bei vielen Projekten herrscht hier jedoch häufig akuter Mangel. Dabei wird einem dies für Standardkommentare besonders einfach gemacht.

Ihr müsst dazu lediglich über eine Klasse oder beliebigen Member davon (z. B. Eigenschaft, Methode) drei Schrägstriche ("///") in Folge schreiben, worauf Visual Studio automatisch einen passenden XML-Kommentarblock erstellt, den ihr vervollständigen könnt. Am besten sehen wir uns ein "fertiges" Beispiel an:
Klasse "Person" mit XML-Dokumentationskommentaren
01020304050607080910111213141516171819202122232425262728293031
/// <summary>/// Stellt eine Person dar./// </summary>public class Person {    /// <summary>    /// Liefert den Vornamen oder legt diesen fest.    /// </summary>    public string FirstName {        get;        set;    }
/// <summary> /// Liefert den Nachnamen oder legt diesen fest. /// </summary> public string LastName { get; set; }

/// <summary> /// Lässt die Person sprechen. /// </summary> /// <param name="textToSay">Text, der gesprochen werden soll.</param> public void Say(string textToSay) { /* * Implementierung für Beispiel nicht notwendig. */ }}
Alle wesentlichen Bestandteile (insbesondere Rückgabewerte und Parameter) lassen sich separat beschreiben, wobei es zusätzlich immer eine Zusammenfassung gibt. Diese Informationen werden bei Verwendung dieser Klasse nun angezeigt, ganz so wie man es von integrierten Typen kennt.

Als besonders nützlich stellt sich dies selbstverständlich dann heraus, wenn die Klasse (beispielsweise als Bestandteil einer Programmbibliothek) weitergegeben und von anderen Entwicklern verwendet werden soll. Hier gibt es jedoch noch eine kleine Hürde zu bewältigen, denn unsere – mehr oder weniger – mühsam erstellten Kommentare überleben den Kompilierungsvorgang nicht. Ihr könnt Visual Studio jedoch anweisen, eine separate XML-Datei hierfür zu erstellen, welche ihr zusammen mit der DLL weitergeben könnt. Ihr findet die entsprechende Einstellung in der Projektkonfiguration unter Erstellen -> XML-Dokumentationsdatei.

Wie üblich gibt es weitere Informationen zur Verwendung im MSDN, insbesondere eine Tag-Übersicht.


Projektverweise

Kategorien / Archiv  |  Übersicht RSS-Feed

Schlagworte

Suche