Dela via

-Doc

  • Artikel

Bearbetar dokumentationskommentar till en XML-fil.

Syntax

-doc[+ | -]

eller

-doc:file

Argument

Period Definition
+ | - Valfritt. Om du anger +, eller bara -doc, genererar kompilatorn dokumentationsinformation och placerar den i en XML-fil. Att - ange motsvarar att -docinte ange , vilket gör att ingen dokumentationsinformation skapas.
file Krävs om -doc: används. Anger XML-utdatafilen, som fylls i med kommentarerna från kompileringskällans källkodsfiler. Om filnamnet innehåller ett blanksteg omger du namnet med citattecken (" ").

Kommentarer

Alternativet -doc styr om kompilatorn genererar en XML-fil som innehåller dokumentationskommentarerna. Om du använder syntaxen -doc:file anger parametern file namnet på XML-filen. Om du använder -doc eller -doc+tar kompilatorn XML-filnamnet från den körbara fil eller det bibliotek som kompilatorn skapar. Om du använder -doc- eller inte anger alternativet -doc skapar kompilatorn inte en XML-fil.

I källkodsfiler kan dokumentationskommenter föregå följande definitioner:

Om du vill använda den genererade XML-filen med funktionen Visual Studio IntelliSense låter du filnamnet för XML-filen vara samma som den sammansättning som du vill stödja. Kontrollera att XML-filen finns i samma katalog som sammansättningen så att även .xml filen hittas när sammansättningen refereras till i Visual Studio-projektet. XML-dokumentationsfiler krävs inte för att IntelliSense ska fungera för kod i ett projekt eller inom projekt som refereras av ett projekt.

Om du inte kompilerar med -target:moduleinnehåller XML-filen taggarna <assembly></assembly>. De här taggarna anger namnet på filen som innehåller sammansättningsmanifestet för kompileringsfilens utdatafil.

Se XML-kommentarstaggar för olika sätt att generera dokumentation från kommentarer i koden.

Så här anger du -doc i den integrerade utvecklingsmiljön i Visual Studio
1. Välj ett projekt i Solution Explorer. Klicka på Egenskaper på projektmenyn.
2. Klicka på fliken Kompilering .
3. Ange värdet i rutan Generera XML-dokumentationsfil .

Exempel

Ett exempel finns i Dokumentera din kod med XML .

Se även