Freigeben über

XDCMake-Aufgabe

  • Artikel

Hinweis

Diese Aufgabe ist nur verfügbar, wenn Sie das C++-Buildsystem verwenden.

Umschließt das XML-Dokumentationstool (xdcmake.exe), das die XML-Dokument-Kommentardateien ( .xdc) in einer XML-Datei zusammengeführt.

Es wird eine XDC-Datei erstellt, wenn Sie Dokumentationskommentare in Ihren C++-Quellcode eingeben und mithilfe der Compileroption /doc kompilieren. Weitere Informationen finden Sie unter XDCMake-Verweis, Eigenschaftenseiten für das Tool XML-Dokument-Generator und unter der Befehlszeilenhilfe-Option ( /? ) für xdcmake.exe.

Bemerkungen

Standardmäßig unterstützt das xdcmake.exe-Tool einige Befehlszeilenoptionen. Zusätzliche Optionen werden bei der Angabe der /old-Befehlszeilenoption unterstützt.

Parameter

In der folgenden Tabelle werden die Parameter der XDCMake-Aufgabe beschrieben.

Parameter Beschreibung
AdditionalDocumentFile Optionaler String[] -Parameter.

Gibt eine oder mehrere weitere XDC-Dateien zum Zusammenführen an.

Weitere Informationen finden Sie unter der Beschreibung Zusätzliche Dokumentdateien unter Eigenschaftenseiten für das XML-Dokument-Generator-Tool. Sehen Sie sich auch die /old- und /FS-Befehlszeilenoptionen für xdcmake.exe an.
AdditionalOptions Optionaler String -Parameter.

Eine Liste von Optionen, wie in der Befehlszeile angegeben. Zum Beispiel, /<option1> /<option2> /<option#>. Verwenden Sie diesen Parameter, um Optionen anzugeben, die nicht durch einen anderen XDCMake-Aufgabenparameter repräsentiert werden.

Weitere Informationen finden Sie unter XDCMake-Verweis, Eigenschaftenseiten für das Tool XML-Dokument-Generator und unter der Befehlszeilenhilfe ( /? ) für xdcmake.exe.
DocumentLibraryDependencies Optionaler Boolean-Parameter.

Wenn true und das aktuelle Projekt über eine Abhängigkeit in einem statischen Bibliotheksprojekt ( .lib) in der Projektmappe verfügen, werden die XDC-Dateien für das Bibliotheksprojekt in der XML-Dateiausgabe für das aktuelle Projekt eingefügt.

Weitere Informationen finden Sie in der Beschreibung Dokumentbibliothekabhängigkeiten unter Eigenschaftenseiten für das Tool XML-Dokument-Generator.
OutputFile Optionaler String -Parameter.

Überschreibt den Standardnamen der Ausgabedatei. Der Standardname wird aus dem Namen der ersten XDC-Datei abgeleitet, die verarbeitet wird.

Weitere Informationen finden Sie unter /out:<filename>-Option in XDCMake-Verweis. Siehe Sie sich auch die /old- und /Fo-Befehlszeilenoptionen für xdcmake.exe an.
Projektname Optionaler String -Parameter.

Der Name des aktuellen Projekts.
SlashOld Optionaler Boolean-Parameter.

Wenn true, werden zusätzliche xdcmake.exe-Optionen aktiviert.

Weitere Informationen finden Sie unter der /old-Befehlszeilenoption für xdcmake.exe.
Sources Erforderlicher ITaskItem[] -Parameter.

Definiert ein Array von MSBuild-Quelldateielementen, die verbraucht und von Aufgaben ausgegeben werden können.
SuppressStartupBanner Optionaler Boolean-Parameter.

Bei true wird die Anzeige der Copyright- und Versionsnummernmeldung bei Aufgabenstart verhindert.

Weitere Informationen finden Sie unter der /nologo-Option im XDCMake-Verweis.
TrackerLogDirectory Optionaler String -Parameter.

Gibt das Verzeichnis für das Nachverfolgungsprotokoll an.

Weitere Informationen