-doc

  • Artikel

Verarbeitet Dokumentationskommentare zu einer XML-Datei.

Syntax

-doc[+ | -]

oder

-doc:file

Argumente

Begriff Definition
+ | - Dies ist optional. Ein Angeben von + oder einfach -doc veranlasst den Compiler, Dokumentationsinformationen zu generieren und diese in eine XML-Datei zu schreiben. Ein Angeben von - entspricht dem Fehlen von -doc, sodass 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, müssen Sie den Namen in Anführungszeichen (" ") setzen.

Hinweise

Die -doc-Option steuert, ob der Compiler eine XML-Datei generiert, die die Dokumentationskommentare enthält. Wenn Sie die -doc:file-Syntax verwenden, gibt der file-Parameter den Namen der XML-Datei an. Wenn Sie -doc oder -doc+ verwenden, übernimmt der Compiler den Namen der XML-Datei von der ausführbaren Datei oder Bibliothek, die vom Compiler erstellt wird. Wenn Sie -doc- verwenden oder die -doc-Option nicht angeben, erstellt der Compiler keine XML-Datei.

In Quellcodedateien können Dokumentationskommentare den folgenden Definitionen vorangestellt sein:

Wenn Sie die generierte XML-Datei mit der IntelliSense-Funktionalität von Visual Studio verwenden möchten, geben Sie für die XML-Datei genau den Dateinamen an, den die Assembly hat, die Sie unterstützen möchten. Stellen Sie sicher, dass sich die XML-Datei im selben Verzeichnis wie die Assembly befindet, sodass auch die XML-Datei gefunden wird, wenn im Visual Studio-Projekt auf die Assembly verwiesen wird. XML-Dokumentationsdateien sind nicht erforderlich, damit IntelliSense für Code in einem Projekt oder in Projekten funktioniert, auf die in einem Projekt verwiesen wird.

Sofern Sie nicht mit -target:module kompilieren, enthä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 zu den Möglichkeiten, wie Dokumentation aus Kommentaren in Ihrem Code generiert werden kann, finden Sie unter XML-Kommentartags.

So legen Sie „-doc“ in der integrierten Visual Studio-Entwicklungsumgebung fest
1. Wählen Sie im Projektmappen-Explorer ein Projekt aus. Klicken Sie im Menü Projekt auf Eigenschaften.
2. Klicken Sie auf die Registerkarte Kompilieren.
3. Legen Sie den Wert im Feld XML-Dokumentationsdatei generieren fest.

Beispiel

Ein Beispiel finden Sie unter Dokumentieren von Code mit XML.

Siehe auch