/doc
Aggiornamento: novembre 2007
Elabora i commenti della documentazione in un file XML.
/doc[+ | -]
' -or-
/doc:file
Argomenti
+ | -
Facoltativo. Se si specifica + o semplicemente /doc, verranno generate informazioni sulla documentazione che saranno inserite in un file XML. Specificando - si ottiene lo stesso effetto che si ottiene non specificando /doc, ovvero non verranno create informazioni sulla documentazione.file
Obbligatorio se viene utilizzato /doc:. Specifica il file XML di output in cui vengono inseriti i commenti presenti nei file di codice sorgente della compilazione. Se il nome file contiene uno spazio, racchiudere il nome tra virgolette (" ").
Note
L'opzione /doc controlla se il compilatore genera un file XML contenente i commenti sulla documentazione. Se si utilizza la sintassi /doc:file, il parametro file specifica il nome del file XML. Se si utilizza /doc o /doc+, il nome del file XML corrisponderà a quello del file eseguibile o della libreria creata dal compilatore. Se si utilizza /doc- o non si specifica l'opzione /doc, il compilatore non creerà alcun file XML.
All'interno dei file di codice sorgente i commenti sulla documentazione possono precedere le seguenti definizioni:
Tipi definiti dall'utente, ad esempio una classe o un'interfaccia
Membri quali un campo, un evento, una proprietà, una funzione o una subroutine.
Per utilizzare il file XML generato con la funzione IntelliSense di Visual Studio, fare in modo che il nome del file XML corrisponda all'assembly che si intende supportare. Assicurarsi che il file XML si trovi nella stessa directory dell'assembly in modo che sia possibile individuarlo quando viene fatto riferimento all'assembly nel progetto di Visual Studio. I file della documentazione XML non sono necessari per l'utilizzo di IntelliSense con il codice all'interno di un progetto o di progetti a cui fa riferimento un progetto.
A meno che non si esegua la compilazione con /target:module, il file XML contiene i tag <assembly></assembly>. Tali tag specificano il nome del file contenente il manifesto assembly per il file di output della compilazione.
Per informazioni sulla generazione di documentazione da commenti presenti nel codice, vedere Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic).
Per impostare l'opzione /doc nell'ambiente di sviluppo integrato di Visual Studio
Selezionare un progetto in Esplora soluzioni. Scegliere Proprietà dal menu Progetto. Per ulteriori informazioni, vedere Introduzione a Progettazione progetti.
Fare clic sulla scheda Compila.
Impostare il valore nella casella Genera il file di documentazione XML.
Esempio
Per un esempio, vedere Documentazione del codice tramite XML (Visual Basic).
Vedere anche
Concetti
Documentazione del codice tramite XML (Visual Basic)