Freigeben über

Dokumentieren Sie Ihren Code mit XML (Visual Basic)

In Visual Basic können Sie Ihren Code mithilfe von XML dokumentieren.

XML-Dokumentationskommentare

Visual Basic bietet eine einfache Möglichkeit zum automatischen Erstellen von XML-Dokumentationen für Projekte. Sie können automatisch ein XML-Skelett für Ihre Typen und Mitglieder generieren und dann Zusammenfassungen und beschreibende Dokumentation für jeden Parameter sowie andere Anmerkungen bereitstellen. Mit dem entsprechenden Setup wird die XML-Dokumentation automatisch in eine XML-Datei mit demselben Stammdateinamen wie Ihr Projekt ausgegeben. Informationen zum Konfigurieren der Generierung der XML-Dokumentationsdatei finden Sie unter "-doc compiler"-Option und " GenerateDocumentationFile MSBuild"-Eigenschaft.

Die XML-Datei kann als XML genutzt oder anderweitig bearbeitet werden. Diese Datei befindet sich im selben Verzeichnis wie die Ausgabe .exe oder .dll Datei Ihres Projekts.

Die XML-Dokumentation beginnt mit '''. Die Verarbeitung dieser Kommentare hat einige Einschränkungen:

  • Die Dokumentation muss wohlgeformtes XML sein. Wenn der XML-Code nicht wohlgeformt ist, wird eine Warnung generiert, und die Dokumentationsdatei enthält einen Kommentar, der besagt, dass ein Fehler aufgetreten ist.

  • Entwickler können ihre eigenen Tags erstellen. Es gibt einen empfohlenen Satz von Tags (siehe XML-Kommentartags). Einige der empfohlenen Tags haben eine besondere Bedeutung:

    • Das <param>-Tag wird verwendet, um Parameter zu beschreiben. Bei Verwendung überprüft der Compiler, ob der Parameter vorhanden ist und dass alle Parameter in der Dokumentation beschrieben werden. Wenn 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. Wenn die Überprüfung fehlschlägt, gibt der Compiler eine Warnung aus. Der Compiler berücksichtigt auch sämtliche Imports Anweisungen bei der Suche nach einem Typ, der im cref-Attribut beschrieben ist.

    • Das <summary> Tag wird von IntelliSense in Visual Studio verwendet, um zusätzliche Informationen zu einem Typ oder Element anzuzeigen.

Ausführliche Informationen zum Erstellen einer XML-Datei mit Dokumentationskommentaren finden Sie in den folgenden Themen:

Siehe auch

  • Last updated on