-doc
Elabora commenti sulla documentazione in un file XML.
Sintassi
-doc[+ | -]
or
-doc:file
Argomenti
| Termine | Definizione |
|---|---|
+ | - |
Facoltativo. Se si specifica +, o semplicemente -doc, il compilatore genera informazioni di documentazione e le inserisce in un file XML. La specifica di - equivale a non specificare -doc, quindi non vengono create informazione di documentazione. |
file |
Richiesto se è usato -doc:. Specifica il file di output XML, popolato con i commenti dai file del codice sorgente della compilazione. Se il nome del file contiene uno spazio, racchiudere il nome tra virgolette doppie (" "). |
Osservazioni:
L'opzione -doc controlla se il compilatore genera un file XML contenente i commenti della documentazione. Se si usa la sintassi -doc:file, il parametro file specifica il nome del file XML. Se si usa -doc o -doc+, il compilatore ottiene il nome del file XML dal file eseguibile o dalla libreria che il compilatore sta creando. Se si usa -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:
Tipi definiti dall'utente, ad esempio una classe o interfaccia
Membri, ad esempio un campo, un evento, una proprietà, una funzione oppure una subroutine.
Per usare il file XML generato con la funzionalità IntelliSense di Visual Studio, usare un nome per il file XML uguale al nome dell'assembly che si vuole supportare. Assicurarsi che il file XML sia nella stessa directory dell'assembly, in modo che quando si fa riferimento all'assembly nel progetto di Visual Studio, venga trovato anche il file XML. I file di documentazione XML non sono necessari per il funzionamento di IntelliSense per il codice all'interno di un progetto o all'interno di progetti a cui viene fatto riferimento da un progetto.
A meno che non si esegua la compilazione 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.
Vedere Tag XML consigliati per i commenti relativi alla documentazione per informazioni su come generare documentazione dai commenti nel codice.
| 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 il file di documentazione XML. |
Esempio
Vedere Documentazione del codice tramite XML per un esempio.
