Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
In diesem Beispiel wird gezeigt, wie Sie Ihrem Code XML-Dokumentationskommentare hinzufügen.
Hinweis
Auf Ihrem Computer werden möglicherweise unterschiedliche Namen oder Speicherorte für einige der Visual Studio-Benutzeroberflächenelemente in den folgenden Anweisungen angezeigt. Die Visual Studio-Edition, über die Sie verfügen, und die Einstellungen, die Sie verwenden, bestimmen diese Elemente. Weitere Informationen finden Sie unter Personalisierung der IDE.
So erstellen Sie die XML-Dokumentation für einen Typ oder ein Mitglied
Positionieren Sie im Code-Editor den Cursor in der Zeile oberhalb des Typs oder Elements, für den Sie eine Dokumentation erstellen möchten.
Typ
'''
(drei einfache Anführungszeichen).Im Code-Editor wird ein XML-Skelett für den Typ oder das Mitglied hinzugefügt.
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.Fügen Sie zusätzlichen Code hinzu, der den Typ oder das Mitglied mit den neuen XML-Dokumentationskommentaren verwendet.
IntelliSense zeigt den Text aus dem <Zusammenfassungstag> für den Typ oder das Element an.
Kompilieren Sie den Code, um eine XML-Datei zu generieren, die die Dokumentationskommentare enthält. Weitere Informationen finden Sie unter -doc.