/doc
Verarbeitet Dokumentationskommentare zu einer XML-Datei.
/doc[+ | -]
' -or-
/doc:file
Argumente
Ausdruck |
Definition |
+ | - |
Optional. Wenn Sie + oder nur /doc angeben, generiert der Compiler Dokumentationsinformationen und platziert diese in einer XML-Datei. Die Angabe von - ist gleichbedeutend mit dem Weglassen von /doc und bewirkt, dass keine Dokumentationsinformationen erstellt werden. |
file |
Erforderlich, wenn /doc: angegeben wird. Legt die XML-Ausgabedatei fest, in die die Kommentare aus den kompilierten Quellcodedateien gefüllt werden. Wenn der Dateiname ein Leerzeichen enthält, schließen Sie den Namen in Anführungszeichen ("") ein. |
Hinweise
Die /doc Option steuert, ob der Compiler eine XML-Datei generiert, die die Dokumentationskommentare enthält. Wenn Sie die Syntax /doc:file verwenden, gibt der file-Parameter den Namen der XML-Datei an. Wenn /doc oder /doc+ verwendet wird, entnimmt der Compiler den Namen der XML-Datei 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 vorausgehen:
Benutzerdefinierte Typen, z. B. eine Klasse oder Schnittstelle
Member, z. B. ein Feld, ein Ereignis, oder eine Eigenschaft, Funktion oder Unterroutine.
Um die generierte XML-Datei mit dem IntelliSense-Feature von Visual Studio zu verwenden, benennen Sie die XML-Datei nach der Assembly, die unterstützt werden soll. Stellen Sie sicher, dass sich XML-Datei und Assembly im selben Verzeichnis befinden, damit auch die XML-Datei gefunden wird, wenn im Visual Studio-Projekt auf die Assembly verwiesen wird. Für den erfolgreichen Einsatz des IntelliSense-Features in Code, der in einem Projekt oder in Projekten, auf die ein Projekt verweist, enthalten ist, sind XML-Dokumentationsdateien nicht erforderlich.
Sofern nicht mit /target:module kompiliert wird, 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.
Möglichkeiten, eine Dokumentation aus Kommentaren im Code zu generieren, finden Sie unter Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic).
So legen Sie /doc in der integrierten Entwicklungsumgebung von Visual Studio fest |
|
Beispiel
Ein Beispiel finden Sie unter Dokumentieren von Code mit XML (Visual Basic).
Siehe auch
Konzepte
Dokumentieren von Code mit XML (Visual Basic)