Dokumentieren von Code mit XML (Visual Basic)
Aktualisiert: November 2007
In Visual Basic können Sie den Code mit XML dokumentieren.
XML-Dokumentationskommentare
Visual Basic erleichtert die automatische Erstellung der XML-Dokumentation für Projekte. Sie können für die Typen und Member automatisch ein XML-Skelett generieren und anschließend Zusammenfassungen, eine erläuternde Dokumentation zu jedem Parameter und weitere Hinweise bereitstellen. Mit der entsprechenden Konfiguration wird die XML-Dokumentation automatisch in eine XML-Datei ausgegeben, die den gleichen Namen wie das Projekt und die Erweiterung XML hat. Weitere Informationen finden Sie unter /doc.
Die XML-Datei kann verwendet werden oder als XML-Code bearbeitet werden. Diese Datei befindet sich in demselben Verzeichnis wie die ausgegebene EXE- oder DLL-Datei des Projekts.
Die XML-Dokumentation beginnt mit '''. Die Verarbeitung dieser Kommentare unterliegt einigen Beschränkungen:
Die Dokumentation muss regelkonformes XML aufweisen. Falls der XML-Code nicht regelkonform ist, wird eine Warnung ausgegeben und ein Kommentar in die Dokumentation eingefügt, dass ein Fehler aufgetreten ist.
Der Entwickler kann auch eigene Tagsets entwickeln. Es gibt eine Reihe empfohlener Tags (siehe "Verwandte Abschnitte" in diesem Thema). Einige der empfohlenen Tags haben eine besondere Bedeutung:
Das <param>-Tag wird zur Beschreibung von Parametern verwendet. Bei Verwendung dieses Tags stellt der Compiler sicher, dass der Parameter vorhanden ist und dass alle Parameter in der Dokumentation beschrieben werden. Falls die Überprüfung fehlschlägt, gibt der Compiler eine Warnung aus.
Das cref-Attribut kann an jedes Tag angefügt werden, um einen Verweis auf ein Codeelement bereitzustellen. Der Compiler überprüft, ob dieses Codeelement vorhanden ist. Falls die Überprüfung fehlschlägt, gibt der Compiler eine Warnung aus. Bei der Suche nach einem im cref-Attribut beschriebenen Typ akzeptiert der Compiler auch die Verwendung von Imports-Anweisungen.
Das <summary>-Tag wird in Visual Studio von IntelliSense verwendet, um zusätzliche Informationen über einen Typ oder einen Member anzuzeigen.
Verwandte Abschnitte
Weitere Informationen über das Erstellen einer XML-Datei mit Dokumentationskommentaren finden Sie unter den folgenden Themen:
Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)
Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic