Blog | Holger Stehle

XML Documentation Comments 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.

Variadic Methods in C# 👍 👎

Variadische Funktionen sind Funktionen, die eine unbestimmte Anzahl von Argumenten (→ Arität) entgegennehmen können. Das passende Stichwort an dieser Stelle für PHP-Entwickler ist hauptsächlich func_get_args. Selbstverständlich bietet beispielsweise auch Java eine entsprechende Möglichkeit. Wie ihr sicher bereits befürchtet habt, lege ich den Fokus im weiteren Verlauf jedoch auf C#. Smiley: grinning

Als Beispiel soll uns eine Methode dienen, welche uns die Summe einer beliebigen Anzahl an Zahlen liefert. Zu Vergleichszwecken erinnern wir uns zuerst einmal daran, wie dieses Problem "normal" gelöst werden kann. Die Lösung ist selbstverständlich, ein Feld zu übergeben:

Nicht-variadische Funktion zur Problemlösung

01020304050607

  // Methode definierenpublic int GetSum(int[] list) {    return list.Sum();}
  // Methode verwendenint sum = GetSum(new int[] { 1, 2, 3 });

Durch eine minimale Anpassung – nämlich indem wir das params-Schlüsselwort vor dem Parameter ergänzen – wird daraus eine variadische Funktion unter Beibehaltung der bisherigen Funktionalität:

Variadische Funktion zur Problemlösung

010203040506070809

  // Methode definierenpublic int GetSum(params int[] list) {    return list.Sum();}
  // Methode verwendenint sum = GetSum(1, 2, 3);  // – oder, ebenfalls möglich -int sum = GetSum(new int[] { 1, 2, 3 });

Wie leicht zu sehen ist, handelt es sich soweit letztlich um eine syntaktische Variante, welche nicht unbedingt notwendig ist. Bei Methoden, die sehr häufig z. B. zwei oder drei Argumente erwarten, prinzipiell jedoch auch mehr denkbar wären, erscheint mir eine solche Möglichkeit jedoch durchaus vernünftig. Das .NET-Framework setzt u. a. bei den Methoden String.Format(…) und String.Join(…) auf dieses Vorgehen.

Zuletzt gilt es aber noch auf folgende Besonderheiten hinzuweisen:

params-Parameter sind generell optional (d. h. GetSum() wäre möglich)
params-Parameter können vor sich fest definierte Parameter besitzen, nicht jedoch danach
params-Parameter dürfen pro Methode lediglich einmal auftreten

Windows-Bibliotheken und NAS 👍 👎

Bei vielen Benutzern scheinen die Windows-Bibliotheken immer noch für mehr Verwirrung als Nutzen zu sorgen. Da ich diese jedoch sehr gerne verwende, möchte ich einen konkreten Anwendungsfall am Beispiel meines tatsächlichen lokalen Netzwerkes im Zusammenhang mit einem NAS erläutern.

Die Ausgangssituation stellt sich so dar, dass ich in meinem Heimnetzwerk sowohl mit einem stationären Rechner arbeite, als auch mit einem Netbook. Da ich meist für die gleiche Arbeit beide Geräte abwechselnd nutze, ergibt sich natürlich umgehend das Problem, die Daten synchron zu halten. Naheliegenderweise besitze ich deshalb zusätzlich ein NAS (für Interessierte: es handelt sich um eine Synology DiskStation*).

Ich habe dazu gemeinsame Ordner für öffentliche Bilder, Dokumente, Musik, Podcasts und Videos angelegt. Da es durchaus auch Dateien gibt, die nicht jeder sehen muss, besitzt jeder angelegte Benutzer auf dem NAS zusätzlich ein home-Verzeichnis. Auf die weiteren – durchaus interessanten – Möglichkeiten des NAS möchte ich nun aber gar nicht weiter eingehen, sondern den Komfort im Zusammenhang mit den Windows-Bibliotheken erläutern; genauer nehmen wir uns die "Bilder"-Bibliothek vor. Standardmäßig zeigt diese nach der Installation von Windows auf die Ordner "Eigene Bilder" (C:\Users\{BENUTZER}\Pictures) und "Öffentliche Bilder" (C:\Users\Public\Pictures).

Mein NAS habe ich nun so konfiguriert, dass die gemeinsamen Ordner als Freigabe zur Verfügung stehen. Für am System angemeldete Benutzer steht außerdem das bereits erwähnte Heimverzeichnis zur Verfügung. Die Bibliotheken habe ich so abgeändert (was ganz einfach über den Eigenschaften-Dialog möglich ist), dass die alten Verzeichnis-Zuordnungen entfallen sind und stattdessen die öffentlichen Freigaben und die entsprechenden Pfade innerhalb meines Heimverzeichnisses eingetragen wurden. Den privaten Ordner habe ich darüber hinaus als Standardspeicherort festgelegt.

Praktisch kann ich nun also genauso wie zuvor arbeiten (insbesondere verhält sich dies Programmen gegenüber weitestgehend transparent), mit dem Unterschied, dass ich nicht mehr auf lokale Daten zugreife, sondern auf das NAS. Durch die Festlegung des Standardspeicherortes auf meine persönliche Freigabe landen alle auf die Bibliothek gezogenen Dokumente (zumindest erst einmal) automatisch dort. Dennoch habe ich aber über die Bibliotheken auf alle Dateien über einen Ort im Windows Explorer Zugriff, wobei ich einzelne Dateien jederzeit beispielsweise von meinem privaten in den öffentlichen Ordner verschieben kann, ohne mir um den konkreten Speicherpfad Gedanken zu machen. Ebenfalls kann nun der Zugriff von allen Geräten auf die gleiche Weise erfolgen, womit im Normalfall (man kann natürlich alles provozieren) keine Inkonsistenzen entstehen können. Für Besitzer eines Windows Phone (wie mich) ist außerdem praktisch, dass Zune – genauso wie der Windows Media Player – standardmäßig ebenfalls auf diese Bibliotheken zugreift und dadurch alle Medien problemlos auch dafür und damit auch zur Synchronisierung mit dem Smartphone zur Verfügung stehen.

Wer ebenfalls per VPN Zugriff auf ein externes Netzwerk (beispielsweise des Unternehmens) hat, kann dessen Freigaben auch einer solchen Bibliothek hinzufügen und so auch darauf zentral zugreifen. Dies finde ich auf jeden Fall deutlich komfortabler über Bibliotheken als die Auswahl über div. Netzlaufwerke. Zugegebenermaßen muss man aber wohl sagen, dass dieser Vorteil erst in ähnlichen Umgebungen wie in meinem Anwendungsfall voll zur Geltung kommt. Sofern man lediglich mit einem Rechner und ohne Netzwerkspeicher arbeitet, d. h. wahrscheinlich sowieso alle Dateien in den eigenen Ordnern ablegt, wird man von den Windows-Bibliotheken tatsächlich nicht wesentlich profitieren. Sie stören meines Erachtens nach aber auch nicht, wenn einem das Konzept der Zusammenführung verschiedener Pfade unter einem virtuellen bewusst ist.

Wer sich für die technischen Details der Bibliotheken interessiert, findet deren Definition übrigens im Verzeichnis C:\Users\{BENUTZERNAME}\AppData\Roaming\Microsoft\Windows\Libraries; die *.library-ms-Dateien enthalten XML-Code.

*) Nein, ich erhalte für diesen Link kein Geld. Smiley: tongue_out

Use Console Output in C# (Appendix) 👍 👎

In meinem Beitrag zur Verwendung der Konsolenausgabe in C# hatte ich aus naheliegenden Gründen eine asynchrone Verarbeitung gewählt. Mich hat nun jedoch die Frage erreicht, wie die komplette Ausgabe auf einmal abzugreifen geht. Auch das ist selbstverständlich kein Problem – man könnte sogar sagen, noch einfacher.

Wir wollen dazu ein Beispiel wählen, welches uns sehr zügig eine vollständige Antwort liefern sollte. Wir rufen dazu die integrierte Hilfe von ipconfig auf. Die grafische Oberfläche besteht nunmehr nur noch aus einer TextBox output und einer Schaltfläche, für die wir die entsprechende Ereignisbehandlung implementieren:

Ereignisbehandlung implementieren

01020304050607080910111213141516

  // Prozessdaten festlegenProcess process = new Process() {    StartInfo = new ProcessStartInfo() {        Arguments = "/?",               // Parameter für Hilfe-Anzeige        CreateNoWindow = true,          // Konsolenanzeige unterbinden        FileName = "ipconfig",          // Programm        RedirectStandardOutput = true,  // Ausgabe umleiten        UseShellExecute = false         // Betriebssystemshell deaktivieren    }};
  // Prozess startenprocess.Start();
  // Ausgabe verarbeitenoutput.Text = process.StandardOutput.ReadToEnd();

Ihr solltet jedoch in jedem Fall beachten, dass dieses Vorgehen zur Blockierung der Benutzeroberfläche führt, wenn das externe Programm nicht schnell genug liefern kann. Dies ist daher nur begrenzt zu empfehlen.

Use Console Output in C# 👍 👎

Manchmal kann es erforderlich sein, in eigenen Projekten auf bestehende Konsolenanwendungen zurückgreifen zu müssen. Meist benötigt man dann jedoch auch Zugriff auf die Ausgabe des Programms, z. B. um diese in einer grafischen Benutzeroberfläche mit Windows Forms – ggf. aufbereitet – darzustellen.

Dies lässt sich ganz einfach mit C# lösen. Als kleines Beispiel zeigen wir dazu die Ausgabe des tracert-Befehls in einer entsprechenden Anwendung an. Diese besteht dabei lediglich aus einer TextBox "targetHost", einer ListBox "output" und einem Button – mit Visual Studio sicherlich kein Problem soweit. Smiley: winking

Jetzt müssen wir lediglich noch die Ereignisbehandlung für einen Klick auf die Schaltfläche implementieren:

Ereignisbehandlung implementieren

0102030405060708091011121314151617181920212223

  // Prozessdaten festlegenProcess process = new Process() {    StartInfo = new ProcessStartInfo() {        Arguments = targetHost.Text,    // Eingabe aus TextBox        CreateNoWindow = true,          // Konsolenanzeige unterbinden        FileName = "tracert",           // Programm        RedirectStandardOutput = true,  // Ausgabe umleiten        UseShellExecute = false         // Betriebssystemshell deaktivieren    }};
  // Ereignisbehandlung registrierenprocess.OutputDataReceived += (s, eventArgs) => {    if(eventArgs.Data != null) {        this.Invoke(new Action(() => {            this.output.Items.Add(eventArgs.Data);        }));    }};
  // Prozess startenprocess.Start();process.BeginOutputReadLine();

Nun werden alle Ausgaben des Konsolenprogramms asynchron als neue Zeile zu output hinzugefügt. Durch dieses Vorgehen blockiert unsere Oberfläche nicht, so dass damit problemlos weitergearbeitet werden kann. In meinem Fall sieht der Inhalt der ListBox für coders-online.net beispielsweise wie folgt aus:

Ausgabe

01020304050607

Routenverfolgung zu coders-online.net [217.160.176.125] über maximal 30 Abschnitte:
 1    <1 ms    <1 ms    <1 ms  Router [192.168.2.1]    ( … gekürzt … ) 9    17 ms    16 ms    17 ms  coders-online.net [217.160.176.125] 
Ablaufverfolgung beendet.

Beachtet zuletzt bitte ggf. auch noch einmal meinen Beitrag zur Freigabe von Ressourcen in C#. Um die Beispiele nicht aufzublähen verzichte ich meist darauf (wie auch auf eine umfassende Fehler- und Ausnahmebehandlung).