Freigeben über

-Doktor

Verarbeitet Dokumentationskommentare zu einer XML-Datei.

Syntax

-doc[+ | -]

oder

-doc:file

Argumente

Begriff Definition
+ | - Wahlfrei. Wenn Sie +, oder nur -doc, angeben, generiert der Compiler Dokumentationsinformationen und platziert sie in einer XML-Datei. Die Angabe - entspricht nicht der Angabe -doc, was dazu führt, dass keine Dokumentationsinformationen erstellt werden.
file Erforderlich, wenn -doc: verwendet wird. Gibt die XML-Ausgabedatei an, die mit den Kommentaren aus den Quellcodedateien der Kompilierung aufgefüllt wird. Wenn der Dateiname ein Leerzeichen enthält, setzen Sie den Namen in Anführungszeichen (" ").

Bemerkungen

Die -doc Option steuert, ob der Compiler eine XML-Datei mit den Dokumentationskommentaren generiert. Wenn Sie die -doc:file Syntax verwenden, gibt der file Parameter den Namen der XML-Datei an. Bei Verwendung -doc oder -doc+, verwendet der Compiler den XML-Dateinamen aus der ausführbaren Datei oder Bibliothek, die der Compiler erstellt. Wenn Sie die -doc Option verwenden -doc- oder nicht angeben, erstellt der Compiler keine XML-Datei.

In Quellcodedateien können Dokumentationskommentare den folgenden Definitionen vorausgehen:

Um die generierte XML-Datei mit dem Visual Studio IntelliSense-Feature zu verwenden, lassen Sie den Dateinamen der XML-Datei mit der Assembly übereinstimmen, die Sie unterstützen möchten. Stellen Sie sicher, dass sich die XML-Datei im selben Verzeichnis wie die Assembly befindet, damit auch beim Verweisen auf die Assembly im Visual Studio-Projekt die .xml Datei gefunden wird. XML-Dokumentationsdateien sind nicht erforderlich, damit IntelliSense für Code innerhalb eines Projekts oder innerhalb von Projekten funktioniert, auf die von einem Projekt verwiesen wird.

Wenn Sie nicht kompilieren, -target:moduleenthält die XML-Datei die Tags <assembly></assembly>. Diese Tags geben den Namen der Datei an, die das Assemblymanifest für die Ausgabedatei der Kompilierung enthält.

Informationen zum Generieren von Dokumentationen aus Kommentaren in Ihrem Code finden Sie unter XML-Kommentartags .

So legen Sie -doc in der integrierten Entwicklungsumgebung von Visual Studio fest
1. Im Projektmappen-Explorer ein Projekt ausgewählt haben. Klicken Sie im Menü Projekt auf Eigenschaften.
2. Klicken Sie auf die Registerkarte " Kompilieren ".
3. Legen Sie den Wert im Feld "XML-Dokumentation generieren" fest .

Beispiel

Ein Beispiel finden Sie unter "Dokumentieren des Codes mit XML ".

Siehe auch

  • Last updated on