/doc (Verarbeiten von Dokumentationskommentaren) (C/C++)

  • Artikel

Bewirkt, dass der Compiler Dokumentationskommentare in Quellcodedateien verarbeitet und für jede Quellcodedatei mit Dokumentationskommentaren eine XDC-Datei erstellt.

Syntax

/doc[name]

Argumente

name
Der Name der XDC-Datei, die der Compiler erstellt. Nur gültig, wenn eine CPP-Datei in der Kompilierung übergeben wird.

Hinweise

Die XDC-Dateien werden in eine XML-Datei mit xdcmake.exe verarbeitet. Weitere Informationen finden Sie unter XDCMake Reference.

Sie können Ihren Quellcodedateien Dokumentationskommentare hinzufügen. Weitere Informationen finden Sie unter Empfohlene Tags für Dokumentationskommentare.

Um die generierte XML-Datei mit IntelliSense zu verwenden, müssen Sie den Dateinamen der XML-Datei mit der Assembly identisch machen, die Sie unterstützen möchten, und die XML-Datei befindet sich im selben Verzeichnis wie die Assembly. Wenn auf die Assembly im Visual Studio-Projekt verwiesen wird, wird auch die XML-Datei gefunden. Weitere Informationen finden Sie unter Verwenden von IntelliSense und Bereitstellen von XML-Codekommentaren.

So legen Sie diese Compileroption in der Visual Studio-Entwicklungsumgebung fest

  1. Öffnen Sie das Dialogfeld Eigenschaftenseiten des Projekts. Weitere Informationen erhalten Sie unter Set C++ compiler and build properties in Visual Studio (Festlegen der Compiler- und Buildeigenschaften (C++) in Visual Studio).

  2. Wählen Sie die Eigenschaftenseite Konfigurationseigenschaften>C/C++>Ausgabedateien aus.

  3. Ändern Sie die Eigenschaft "XML-Dokumentationsdateien generieren".

So legen Sie diese Linkeroption programmgesteuert fest

Siehe auch

MSVC-Compileroptionen
Syntax für die MSVC-Compilerbefehlszeile