/doc (Elabora i commenti per la documentazione) (C/C++)

  • Articolo

Fa sì che il compilatore eselabori i commenti della documentazione nei file di codice sorgente e crei un file con estensione xdc per ogni file di codice sorgente con commenti relativi alla documentazione.

Sintassi

/doc[name]

Argomenti

name
Nome del file con estensione xdc che verrà creato dal compilatore. Valido solo quando viene passato un file con estensione cpp nella compilazione.

Osservazioni:

I file con estensione xdc vengono elaborati in un file xml con xdcmake.exe. Per altre informazioni, vedere Informazioni di riferimento su XDCMake.

È possibile aggiungere commenti alla documentazione ai file di codice sorgente. Per altre informazioni, vedere Tag consigliati per i commenti relativi alla documentazione.

Per usare il file xml generato con IntelliSense, impostare il nome file del file xml come l'assembly che si desidera supportare e inserire il file con estensione xml nella stessa directory dell'assembly. Quando si fa riferimento all'assembly nel progetto di Visual Studio, viene trovato anche il file con estensione xml. Per altre informazioni, vedere Uso di IntelliSense e fornitura di commenti di codice XML.

Per impostare l'opzione del compilatore nell'ambiente di sviluppo di Visual Studio

  1. Aprire la finestra di dialogo Pagine delle proprietà del progetto. Per informazioni dettagliate, vedere Impostare il compilatore e le proprietà di compilazione.

  2. Selezionare la pagina delle proprietà Proprietà>di configurazione C/C++>File di output.

  3. Modificare la proprietà Genera file di documentazione XML.

Per impostare l'opzione del linker a livello di codice

Vedi anche

Opzioni del compilatore MSVC
Sintassi della riga di comando del compilatore MSVC