Empfohlene Tags für Dokumentationskommentare

Der MSVC Compiler verarbeitet Dokumentationskommentare in Ihrem Code, um eine XDC-Datei für jede kompilierte Quelldatei zu erstellen. Anschließend verarbeitet xdcmake.exe die XDC-Dateien, um eine XML-Dokumentationsdatei zu erstellen. Die Verarbeitung der XML-Datei zum Erstellen der Dokumentation ist ein Detail, das an Ihrer Website implementiert werden muss.

Tags werden auf der Basis von Konstrukten wie Typen und Typmember verarbeitet.

Tags müssen Typen oder Membern unmittelbar vorangestellt werden.

Hinweis

Dokumentationskommentare können nicht auf einen Namespace oder out-of-line-Definitionen für Eigenschaften und Ereignisse angewendet werden. -Dokumentationskommentare müssen in den klassenübergreifenden Deklarationen enthalten sein.

Der Compiler verarbeitet alle Tags, die gültige XML sind. Die folgenden Tags stellen häufig verwendete Funktionen in der Benutzerdokumentation bereit:

<c>
<code>
<example>
<exception>1
<include>1
<list>
<para>
<param>1
<paramref>1
<permission>1
<remarks>
<returns>
<see>1
<seealso>1
<summary>
<value>

  1. Der Compiler überprüft die Syntax.

In der aktuellen Version unterstützt <paramref>der MSVC Compiler nicht , ein Tag, das von anderen Visual Studio Compilern unterstützt wird. Möglicherweise unterstützt Visual C++ <paramref> in einem zukünftigen Release.

Weitere Informationen

XML-Dokumentation