Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)
Il compilatore Visual Basic può elaborare i commenti della documentazione nel codice in un file XML. È possibile usare strumenti aggiuntivi per elaborare il file XML nella documentazione.
I commenti XML sono consentiti nei costrutti di codice, ad esempio tipi e membri di tipo. Per i tipi parziali, solo una parte del tipo può avere commenti XML, anche se non esiste alcuna restrizione sul commento dei relativi membri.
Nota
I commenti della documentazione non possono essere applicati agli spazi dei nomi. Il motivo è che uno spazio dei nomi può estendersi su diversi assembly e non tutti gli assembly devono essere caricati contemporaneamente.
Il compilatore elabora qualsiasi tag che è XML valido. I tag seguenti forniscono funzionalità comunemente usate nella documentazione dell'utente.
- <C>
- <Codice>
- <Esempio>
- <eccezione1>
- <include1>
- <Elenco>
- <Para>
- <param1>
- <paramref>
- <autorizzazione1>
- <Osservazioni>
- <Restituisce>
- <see1>
- <seealso1>
- <Riepilogo>
- <typeparam1>
- <Valore>
(1 Il compilatore verifica la sintassi).
Nota
Se si desidera che le parentesi angolari vengano visualizzate nel testo di un commento della documentazione, usare < e >. Ad esempio, la stringa "<text in angle brackets>" verrà visualizzata come <text in angle brackets>.