Leseprobe

144
Kommentarbasierte Dokumentation in XML
Dieser Kommentar enthält somit einen Verweis auf die Beschreibung der Klasse
RequestWebPage. Beachten Sie, dass die Tags der XML-Syntax unterworfen sind,
also die Unterscheidung zwischen Groß- und Kleinschreibung eine Rolle spielt.
Ein anderes interessantes Tag für Dokumentation von Elementen ist das -Tag.
Es gestattet Ihnen, Querverweise auf andere Themen einzufügen, die
für den Leser interessant sein könnten:
///
Der Querverweis in diesem Beispiel ermöglicht es dem Benutzer, in die Dokumentation
für den Namensraum System.Net zu verzweigen. Sofern Sie auf ein
Element verweisen, das im aktuellen Namensraum nicht sichtbar ist, müssen Sie
den vollständig qualifizierten Bezeichner angegeben.
Das folgende Listing demonstriert wie angekündigt am Beispiel der Klasse
RequestWebPage, wie die professionelle Dokumentation von Elementen konkret
aussehen kann. Beachten Sie, wie die einzelnen XML-Tags angeordnet und verschachtelt
sind:
Listing 9.5:
Dokumentation von Elementen mit den Tags , ,
und
1: using System;
2: using System.Net;
3: using System.IO;
4: using System.Text;
5:
6: /// Klasse fordert eine Webseite von einem Webserver an
7: public class RequestWebPage
8: {
9: private const int BUFFER_SIZE = 128;
10:
11: /// m_strURL speichert den URL der Webseite
12: private string m_strURL;
13:
14: /// RequestWebPage() ist der Konstruktor der Klasse
15: /// für Aufruf ohne Argumente.
16: public RequestWebPage()
17: {
18: }
19:
20: /// RequestWebPage(string strURL) ist der Konstruktor der
Klasse
21: /// bei Initialisierung mit URL.