/doc (Dokumentationskommentare verarbeiten) (C#-Compileroptionen)

Artikel
08/20/2008

Aktualisiert: November 2007

Mit der Option /doc können Sie Dokumentationskommentare in eine XML-Datei einfügen.

/doc:file

Argumente

file
die Ausgabedatei für XML, in die die Kommentare der Quellcodedateien der Kompilierung eingetragen werden.

Hinweise

Dokumentationskommentare, die in Quellcodedateien folgenden Typen bzw. Membern vorangestellt sind, können verarbeitet und der XML-Datei hinzugefügt werden:

Benutzerdefinierten Typen wie class, delegate oder interface
Membern wie Feldern, Ereignissen, Eigenschaften oder Methoden

Die Quellcodedatei, die Main enthält, wird zuerst in die XML ausgegeben.

Um die generierte XML-Datei mit dem IntelliSense-Feature zu verwenden, benennen Sie die XML-Datei nach der Assembly, die unterstützt werden soll, und stellen anschließend sicher, dass sich XML-Datei und Assembly im selben Verzeichnis befinden. Wenn dann im Visual Studio-Projekt auf die Assembly verwiesen wird, wird die XML-Datei auch gefunden. Weitere Informationen finden Sie unter Anzeigen von Codekommentaren.

Wenn Sie nicht mit /target:module kompilieren, enthält file <assembly></assembly>-Tags, die den Namen der Datei angeben, die das Assemblymanifest für die Ausgabedatei der Kompilierung enthält.

Hinweis:
Die Option /doc gilt für alle Eingabedateien. Wenn dies in den Projekteinstellungen festgelegt wurde, gilt diese Option für alle Dateien im Projekt. Warnungen zu Dokumentationskommentaren für eine bestimmte Datei oder einen bestimmten Codeabschnitt können Sie deaktivieren, indem Sie #pragma warning verwenden.

Informationen über Möglichkeiten zum Erstellen von Dokumentationen anhand von Codekommentaren finden Sie unter Empfohlene Tags für Dokumentationskommentare.

Ein Beispiel finden Sie unter Beispiel für die XML-Dokumentation.