Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic

In diesem Beispiel wird veranschaulicht, wie dem Code XML-Dokumentationskommentare hinzugefügt werden.

Hinweis

Auf Ihrem Computer werden möglicherweise andere Namen oder Speicherorte für die Benutzeroberflächenelemente von Visual Studio angezeigt als die in den folgenden Anweisungen aufgeführten. Diese Elemente sind von der jeweiligen Visual Studio-Version und den verwendeten Einstellungen abhängig. Weitere Informationen finden Sie unter Anpassen der Entwicklungseinstellungen in Visual Studio.

So erstellen Sie eine XML-Dokumentation für einen Typ oder einen Member

1. Bewegen Sie den Cursor im Code-Editor in die Zeile über dem Typ oder Member, zu dem eine Dokumentation erstellt werden soll.

2. Geben Sie ''' (drei einfache Anführungszeichen) ein.

   Im Code-Editor wird ein XML-Skelett für den Typ oder Member hinzugefügt.

3. Fügen Sie beschreibende Informationen zwischen den entsprechenden Tags hinzu.

   Hinweis

   Wenn Sie zusätzliche Zeilen innerhalb des XML-Dokumentationsblocks hinzufügen, muss jede Zeile mit ''' anfangen.

4. Fügen Sie weiteren Code hinzu, in dem der Typ oder der Member mit den neuen XML-Dokumentationskommentaren verwendet wird.

   IntelliSense zeigt den Text aus dem < summary >-Tag für den Typ oder den Member an.

5. Kompilieren Sie den Code, um eine XML-Datei zu generieren, die die Dokumentationskommentare enthält. Weitere Informationen finden Sie unter /doc.

Siehe auch

Referenz

Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)

/doc

Konzepte

Dokumentieren von Code mit XML (Visual Basic)