/doc (C#-Compileroptionen)

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

Syntax

/doc:file  

Argumente

file
Die Ausgabedatei für XML, die mit den Kommentaren in den Quellcodedateien der Kompilierung aufgefüllt wird.

Hinweise

In Quellcodedateien können Dokumentationskommentare, die Folgendem vorausgehen, verarbeitet und der XML-Datei hinzugefügt werden:

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

Lassen Sie den Dateinamen der XML-Datei mit der Assembly, die Sie unterstützen möchten, identisch sein, und stellen Sie sicher, dass sich die XML-Datei im gleichen Verzeichnis wie die Assembly befindet, um die generierte XML-Datei für die Verwendung mit der IntelliSense-Funktion zu verwenden. Demnach wird auch die XML-Datei gefunden, wenn im Visual Studio-Projekt auf die Assembly verwiesen wird. Weitere Informationen finden Sie unter Anzeigen von XML-Codekommentaren.

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

Hinweis

Die Option „/doc“ gilt für alle Eingabedateien; oder, wenn sie in den Projekteinstellungen festgelegt wurde, für alle Dateien im Projekt. Verwenden Sie zum Deaktivieren von Warnungen im Zusammenhang mit Dokumentationskommentare für eine bestimmte Datei oder einen Codeabschnitt #pragma warning.

Weitere Informationen für Methoden zum Generieren von Dokumentation aus Kommentaren in Ihrem Code finden Sie unter Empfohlene Tags für Dokumentationskommentare.

So legen Sie diese Compileroption in der Visual Studio-Entwicklungsumgebung fest

  1. Öffnen Sie die Eigenschaften-Seite des Projekts.

  2. Klicken Sie auf die Registerkarte Erstellen.

  3. Ändern Sie die Eigenschaft der XML-Dokumentationsdatei.

Informationen zum programmatischen Festlegen dieser Compileroption finden Sie unter DocumentationFile.

Siehe auch

C#-Compileroptionen
Vorgehensweise: Ändern von Projekteigenschaften und Konfigurationseinstellungen