XML Documentation (Visual C++)

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:

1. Wenn der Code wie eine Windows Runtime-Komponente mit einer begleitenden .winmd-Datei kompiliert wurde

2. wenn der Quellcode im aktuellen enthalten ist, fügen Sie

3. in einer Bibliothek, deren Typdeklarationen und Implementierungen in derselben Headerdatei sind

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	/doc
Tags, die Sie verwenden können, um häufig verwendete Funktionen in der Dokumentation bereitzustellen	Empfohlene Tags für Dokumentationskommentare
Die ID-Zeichenfolgen, die der Compiler generiert, um die Konstrukte im Code zu identifizieren	Verarbeiten der XML-Datei
Erstellen Dokumentationstags getrennt werden	Trennzeichen für Visual C++-Dokumentations-Tags
Generieren einer XML-Datei aus einem oder mehreren .xdc-Dateien.	XDCMake-Verweis
Links zu Informationen über XML, wie es in Visual Studio-Funktionsbereichen verknüpft	XML in Visual Studio

Wenn Sie XML-Sonderzeichen im Text eines Dokumentationskommentars ablegen müssen, müssen Sie XML-Entitäten oder einen CDATA-Abschnitt verwenden.

Siehe auch

Konzepte

Sprachfeatures zum Anvisieren der CLR