Freigeben über

Recommended Tags for Documentation Comments (Visual C++)

  • Artikel

Der Visual C++-Compiler verarbeitet Dokumentationskommentare im Code und stellt eine XDC-Datei für jede Kompiliereinheit erstellt, und xdcmake.exe verarbeitet die .xdc-Dateien zu einer XML-Datei.Die XML-Datei zu verarbeiten, um Dokumentation zu erstellen ist ein Detail, das an der Site implementiert werden muss.

Tags werden auf Konstrukten wie Typen und Typmember verarbeitet.

Tags müssen Typen oder Member unmittelbar vor.

HinweisHinweis

Dokumentationskommentare können nicht in einem Namespace oder an aus Zeilendefinition aus für Eigenschaften und Ereignisse angewendet werden; Dokumentationskommentare müssen auf den InKlassendeklarationen.

Der Compiler verarbeitet jedes Tag, das gültiges XML darstellt.Die folgenden Tags stellen häufig verwendete Funktionen in der Benutzerdokumentation:

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>1

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<value>

 

 

1.Compiler überprüft Syntax.

In der aktuellen Version unterstützt der Visual C++-Compiler nicht <paramref>, ein Tag, das von anderen Visual Studio-Compiler unterstützt wird.Visual C++ unterstützt <paramref> möglicherweise in einer zukünftigen Version.

Siehe auch

Weitere Ressourcen

XML Documentation (Visual C++)