Documentazione XML (Visual C++)
In Visual C++, è possibile aggiungere commenti al codice sorgente che verrà elaborato in un file xml.Questo file può essere l'input in un processo che crea la documentazione per le classi nel codice.
In un file di codice di Visual C++, commenti della documentazione XML devono risiedere immediatamente prima di un metodo o di una definizione di tipo.I commenti possono essere utilizzati per popolare il suggerimento dati Intellisense informazioni rapide negli scenari seguenti:
quando il codice viene compilato come parte del runtime di Windows con associato un file di .winmd
quando il codice sorgente è incluso nel progetto corrente
in una raccolta di cui dichiarazioni di tipo e le implementazioni si trovano nello stesso file di intestazione
[!NOTA]
Nella versione corrente, i commenti del codice non vengono elaborati sui modelli o su qualsiasi elemento che contengono un tipo di modello, ad esempio una funzione che accetta un parametro come modello).L'aggiunta di questi commenti è un comportamento indefinito.
Per informazioni dettagliate sulla creazione di un file XML con i commenti della documentazione, vedere i seguenti argomenti.
Per informazioni su |
Vedere |
|---|---|
Le opzioni del compilatore utilizzare |
|
Tag che è possibile utilizzare per fornire funzionalità comunemente utilizzati nella documentazione |
|
Le stringhe ID che il compilatore genera per identificare i costrutti nel codice |
|
Come delimitare i tag della documentazione |
|
Generazione di file XML da uno o più file xdc. |
|
Collegamenti a informazioni su XML in relazione alle aree funzionali di Visual Studio |
Se è necessario inserire caratteri speciali XML nel testo di un commento relativo alla documentazione, è necessario utilizzare entità XML o una sezione CDATA.