-doc (C#-Compileroptionen)-doc (C# Compiler Options)

Mit der Option -doc können Sie Dokumentationskommentare in eine XML-Datei einfügen.The -doc option allows you to place documentation comments in an XML file.

SyntaxSyntax

-doc:file  

ArgumenteArguments

file
Die Ausgabedatei für XML, die mit den Kommentaren in den Quellcodedateien der Kompilierung aufgefüllt wird.The output file for XML, which is populated with the comments in the source code files of the compilation.

HinweiseRemarks

In Quellcodedateien können Dokumentationskommentare, die Folgendem vorausgehen, verarbeitet und der XML-Datei hinzugefügt werden:In source code files, documentation comments that precede the following can be processed and added to the XML file:

Die Quellcodedatei, die Main enthält, wird zuerst in XML ausgegeben.The source code file that contains Main is output first into the XML.

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.To use the generated .xml file for use with the IntelliSense feature, let the file name of the .xml file be the same as the assembly you want to support and then make sure the .xml file is in the same directory as the assembly. Demnach wird auch die XML-Datei gefunden, wenn im Visual Studio-Projekt auf die Assembly verwiesen wird.Thus, when the assembly is referenced in the Visual Studio project, the .xml file is found as well. Weitere Informationen finden Sie unter Anzeigen von XML-Codekommentaren.See Supplying Code Comments and for more information.

Wenn Sie nicht mit -target:module kompilieren, enthält file die Tags <assembly></assembly>, die den Namen der Datei mit dem Assemblymanifest für die Ausgabedatei der Kompilierung angeben.Unless you compile with -target:module, file will contain <assembly></assembly> tags specifying the name of the file containing the assembly manifest for the output file of the compilation.

Hinweis

Die Option „-doc“ gilt für alle Eingabedateien; oder, wenn sie in den Projekteinstellungen festgelegt wurde, für alle Dateien im Projekt.The -doc option applies to all input files; or, if set in the Project Settings, all files in the project. Verwenden Sie zum Deaktivieren von Warnungen im Zusammenhang mit Dokumentationskommentare für eine bestimmte Datei oder einen Codeabschnitt #pragma warning.To disable warnings related to documentation comments for a specific file or section of code, use #pragma warning.

Weitere Informationen für Methoden zum Generieren von Dokumentation aus Kommentaren in Ihrem Code finden Sie unter Empfohlene Tags für Dokumentationskommentare.See Recommended Tags for Documentation Comments for ways to generate documentation from comments in your code.

So legen Sie diese Compileroption in der Visual Studio-Entwicklungsumgebung festTo set this compiler option in the Visual Studio development environment

  1. Öffnen Sie die Eigenschaften-Seite des Projekts.Open the project's Properties page.

  2. Klicken Sie auf die Registerkarte Erstellen.Click the Build tab.

  3. Ändern Sie die Eigenschaft der XML-Dokumentationsdatei.Modify the XML documentation file property.

Informationen zum programmgesteuerten Festlegen dieser Compileroption finden Sie unter DocumentationFile.For information on how to set this compiler option programmatically, see DocumentationFile.

Siehe auchSee Also