Condividi tramite

-dottore

Elabora commenti sulla documentazione in un file XML.

Sintassi

-doc[+ | -]

o

-doc:file

Argomenti

Termine Definizione
+ | - Opzionale. Se si specifica +, o semplicemente -doc, il compilatore genera informazioni sulla documentazione e lo inserisce in un file XML. Specificare - è l'equivalente di non specificare -doc, causando la creazione di informazioni sulla documentazione.
file Obbligatorio se -doc: viene usato. Specifica il file XML di output, popolato con i commenti dei file di codice sorgente della compilazione. Se il nome del file contiene uno spazio, racchiudere il nome tra virgolette (" ").

Osservazioni:

L'opzione -doc controlla se il compilatore genera un file XML contenente i commenti della documentazione. Se si utilizza la -doc:file sintassi , il file parametro specifica il nome del file XML. Se si usa -doc o -doc+, il compilatore accetta il nome del file XML dal file eseguibile o dalla libreria che il compilatore sta creando. Se si utilizza -doc- o non si specifica l'opzione -doc , il compilatore non crea un file XML.

Nei file di codice sorgente i commenti della documentazione possono precedere le definizioni seguenti:

Per usare il file XML generato con la funzionalità IntelliSense di Visual Studio, lasciare che il nome file del file XML corrisponda all'assembly che si vuole supportare. Assicurarsi che il file XML si trovi nella stessa directory dell'assembly in modo che quando viene fatto riferimento all'assembly nel progetto di Visual Studio, viene trovato anche il file .xml. I file di documentazione XML non sono necessari affinché IntelliSense funzioni per il codice all'interno di un progetto o all'interno di progetti a cui fa riferimento un progetto.

A meno che non si compili con -target:module, il file XML contiene i tag <assembly></assembly>. Questi tag specificano il nome del file contenente il manifesto dell'assembly per il file di output della compilazione.

Per informazioni su come generare la documentazione dai commenti nel codice, vedere Tag di commento XML .

Per impostare -doc nell'ambiente di sviluppo integrato di Visual Studio
1. Selezionare un progetto in Esplora soluzioni. Scegliere Proprietà dal menu Progetto.
2. Fare clic sulla scheda Compila .
3. Impostare il valore nella casella Genera file di documentazione XML .

Esempio

Per un esempio, vedere Documenting Your Code with XML (Documentazione del codice con XML ).

Vedere anche

  • Last updated on