/doc (elaborazione dei commenti per la documentazione) (opzioni del compilatore C#)
Aggiornamento: novembre 2007
L'opzione /doc consente di inserire commenti per la documentazione in un file XML.
/doc:file
Argomenti
- file
Rappresenta il file di output per XML, compilato con i commenti presenti nei file di codice sorgente della compilazione.
Note
Nei file di codice sorgente è possibile elaborare e aggiungere al file XML i commenti relativi alla documentazione che precedono quanto segue:
Tipi definiti dall'utente quali una classe, un delegato o un'interfaccia
Il primo output inserito nel file XML è quello del file di codice sorgente che contiene Main.
Per utilizzare il file XML generato con la funzionalità IntelliSense, assegnare al file XML lo stesso nome dell'assembly che si desidera supportare, quindi accertarsi che il file XML si trovi nella stessa directory dell'assembly. In questo modo quando si farà riferimento all'assembly nel progetto Visual Studio, verrà trovato anche il file XML. Per ulteriori informazioni, vedere Commenti al codice.
Se non si esegue la compilazione con /target:module, file conterrà tag <assembly></assembly> che specificano il nome del file contenente il manifesto assembly per il file di output della compilazione.
.gif "Nota") Nota: |
|---|
L'opzione /doc può essere utilizzata per tutti i file di input o, se definita in Impostazioni progetto, per tutti i file di un progetto. Per disattivare la visualizzazione degli avvisi relativi ai commenti di documentazione per una sezione di codice o un file specifico, utilizzare #pragma warning. |
Per informazioni sulla generazione di documentazione da commenti presenti nel codice, vedere Tag consigliati per i commenti relativi alla documentazione.
Per un esempio, vedere Esempio di documentazione XML.
Per impostare l'opzione del compilatore nell'ambiente di sviluppo di Visual Studio
Aprire la pagina Proprietà del progetto.
Modificare la proprietà File di documentazione XML.
Per informazioni su come impostare questa opzione del compilatore a livello di codice, vedere DocumentationFile.