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 Visual C++ können Sie Kommentare Quellcode hinzufügen, der einer XML-Datei verarbeitet wird.Diese Datei kann als Eingabe für einen Prozess dann sein, der Dokumentation für die Klassen im Code erstellt.
In einer Visual C++-Codedatei müssen sich XML-Dokumentationskommentare direkt vor einer Methode oder Typdefinition befinden.Kommentare können verwendet werden, um den IntelliSense-QuickInfo-Datentipp in den folgenden Szenarien aufzufüllen:
Wenn der Code wie eine Windows Runtime-Komponente mit einer begleitenden .winmd-Datei kompiliert wurde
wenn der Quellcode im aktuellen enthalten ist, fügen Sie
in einer Bibliothek, deren Typdeklarationen und Implementierungen in derselben Headerdatei sind
.gif "Hinweis") Hinweis |
|---|
In der aktuellen Version werden Codekommentare auf Vorlagen oder nichts verarbeitet, die einen Vorlagentyp enthalten (beispielsweise, eine Funktion, die einen Parameter als Vorlage verwendet).Das Hinzufügen dieser Kommentare bewirkt nicht definiertes Verhalten. |
Weitere Informationen über das Erstellen einer XML-Datei mit Dokumentationskommentaren, finden Sie unter folgenden Themen.
Informationen über |
Siehe |
|---|---|
Die Compileroptionen zu verwenden |
|
Tags, die Sie verwenden können, um häufig verwendete Funktionen in der Dokumentation bereitzustellen |
|
Die ID-Zeichenfolgen, die der Compiler generiert, um die Konstrukte im Code zu identifizieren |
|
Erstellen Dokumentationstags getrennt werden |
|
Generieren einer XML-Datei aus einem oder mehreren .xdc-Dateien. |
|
Links zu Informationen über XML, wie es in Visual Studio-Funktionsbereichen verknüpft |
Wenn Sie XML-Sonderzeichen im Text eines Dokumentationskommentars ablegen müssen, müssen Sie XML-Entitäten oder einen CDATA-Abschnitt verwenden.