XML-Dokumentation (Visual C++)

  • Artikel

In Visual C++ können Sie Ihrem Quellcode Kommentare hinzufügen, die in einer XML-Dokumentationsdatei verarbeitet werden. Die Datei kann dann als Eingabe für einen Prozess verwendet werden, der die Klassen im Code dokumentiert.

In einer Visual C++-Codedatei müssen sich XML-Dokumentationskommentare direkt vor einer Methode oder Typdefinition befinden. Die Kommentare können dazu verwendet werden, den Datentipp der IntelliSense-QuickInfo in den folgenden Szenarios aufzufüllen:

  1. Wenn der Code als Windows-Runtime Komponente mit einer WINMD-Datei kompiliert wird

  2. Wenn der Quellcode im aktuellen Projekt enthalten ist

  3. In einer Bibliothek, deren Typdeklarationen und Implementierungen sich in derselben Headerdatei befinden

Hinweis

In der aktuellen Version werden Codekommentare nicht für Vorlagen oder elemente verarbeitet, die einen Vorlagentyp enthalten (z. B. eine Funktion, die einen Parameter als Vorlage verwendet). Das Hinzufügen solcher Kommentare führt zu nicht definiertem Verhalten.

Ausführliche Informationen zum Erstellen einer XML-Datei mit Dokumentationskommentaren finden Sie in den folgenden Artikeln.

Informationen über Siehe
Die zu verwendenden Compileroptionen /doc
Tags, die Sie zum Bereitstellen häufig verwendeter Funktionen in Dokumentationen verwenden können. Empfohlene Tags für Dokumentationskommentare
ID-Zeichenfolgen, die der Compiler erstellt, um die Konstrukte in Ihrem Code zu identifizieren. Verarbeiten der XML-Datei
Trennen von Dokumentationstags Trennzeichen für Visual C++-Dokumentationstags
Generieren einer XML-Datei aus einer oder mehreren XDC-Dateien. XDCMake-Referenz
Links zu Informationen über XML im Bezug auf Visual Studio-Featurebereiche XML in Visual Studio

Wenn Sie XML-Sonderzeichen in den Text eines Dokumentationskommentars einfügen müssen, müssen Sie XML-Entitäten oder einen CDATA-Abschnitt verwenden.

Siehe auch

Komponentenerweiterungen für Laufzeitplattformen