/doc (Verarbeiten von Dokumentationskommentaren) (C/C++)
Durch diese Option werden vom Compiler Dokumentationskommentare in Quellcodedateien verarbeitet, und für jede Quellcodedatei mit Dokumentationskommentaren wird eine XDC-Datei erstellt.
/doc[name]
Argumente
- name
Der Name der XDC-Datei, die vom Compiler erstellt wird. Nur gültig, wenn bei der Kompilierung eine CPP-Datei übergeben wird.
Hinweise
Die XDC-Dateien werden mit xdcmake.exe in eine XML-Datei umgewandelt. Weitere Informationen finden Sie unter XDCMake Reference.
Sie können den Quellcodedateien Dokumentationskommentare hinzufügen. Weitere Informationen finden Sie unter Recommended Tags for Documentation Comments (Visual C++).
/doc ist nicht mit /clr:oldSyntax kompatibel. Weitere Informationen finden Sie unter /clr (Common Language Runtime-Kompilierung).
Um die erzeugte XML-Datei in IntelliSense zu verwenden, weisen Sie der XML-Datei denselben Namen zu wie der Assembly, die unterstützt werden soll, und legen die XML-Datei in dem Verzeichnis ab, in dem sich auch die Assembly befindet. Wenn im Visual Studio-Projekt auf die Assembly verwiesen wird, wird die entsprechende XML-Datei ebenfalls gefunden. Weitere Informationen finden Sie unter Verwenden von IntelliSense und unter Anzeigen von XML-Codekommentaren.
So legen Sie diese Compileroption in der Visual Studio-Entwicklungsumgebung fest
Öffnen Sie das Dialogfeld Eigenschaftenseiten des Projekts. Ausführliche Informationen finden Sie unter Gewusst wie: Öffnen von Projekteigenschaftenseiten.
Erweitern Sie den Knoten Konfigurationseigenschaften.
Erweitern Sie den Knoten C/C++.
Wählen Sie die Eigenschaftenseite für die Ausgabedateien aus.
Ändern Sie die Eigenschaft XML-Dokumentationsdateien generieren.