Documentazione XML (Visual C++)
In Visual C++, è possibile aggiungere commenti al codice sorgente elaborato in un file di documentazione XML. Questo file può essere l'input in un processo che crea la documentazione per le classi nel codice.
In un file di codice Visual C++ i commenti della documentazione XML devono trovarsi direttamente prima di un metodo o una definizione di tipo. I commenti possono essere usati per popolare il suggerimento dati Informazioni rapide Intellisense negli scenari seguenti:
Quando il codice viene compilato come componente Windows Runtime con un file WINMD
Quando il codice sorgente viene incluso nel progetto corrente
In una libreria le cui dichiarazioni di tipo e implementazioni si trovano nello stesso file di intestazione
Nota
Nella versione corrente, i commenti di codice non vengono elaborati nei modelli o in qualsiasi elemento contenente un tipo di modello, ad esempio una funzione che accetta un parametro come modello. Aggiungendo tali commenti si otterrà un comportamento non definito.
Per informazioni dettagliate sulla creazione di un file XML con commenti sulla documentazione, vedere gli articoli seguenti.
| Per informazioni su | Vedere |
|---|---|
| Opzioni del compilatore da usare | /doc |
| Tag che si possono usare per specificare le funzionalità usate comunemente nella documentazione | Tag consigliati per i commenti della documentazione |
| Stringhe ID generate dal compilatore per identificare i costrutti nel codice | Elaborazione del file XML |
| Come delimitare i tag della documentazione | Delimitatori per i tag della documentazione di Visual C++ |
| Generazione di un file XML da uno o più file XDC. | Informazioni di riferimento su XDCMake |
| Collegamenti a informazioni su XML in quanto correlato alle aree di funzionalità di Visual Studio | XML in Visual Studio |
Se è necessario inserire i caratteri speciali XML nel testo di un commento della documentazione, è necessario usare le entità XML o una sezione CDATA.