Freigeben über

Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic

  • Artikel

In diesem Beispiel wird gezeigt, wie Sie Ihrem Code XML-Dokumentationskommentare hinzufügen.

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 Personalisieren der IDE.

So erstellen Sie die XML-Dokumentation für einen Typ oder ein Mitglied

  1. Positionieren Sie im Code-Editorden Cursor in der Zeile oberhalb des Typs oder Elements, für den Sie eine Dokumentation erstellen möchten.

  2. Typ ''' (drei einfache Anführungszeichen).

    Im Code-Editor wird eine XML-Skelett für den Typ oder das Element 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 ''' beginnen.

  4. Fügen Sie zusätzlichen Code hinzu, der den Typ oder Member mit den neuen XML-Dokumentationskommentaren verwendet.

    IntelliSense zeigt den Text aus dem <Zusammenfassungstag> für den Typ oder das Element 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