Tag XML consigliati per i commenti della 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 per l'inserimento di commenti sui relativi membri.

Annotazioni

I commenti della documentazione non possono essere applicati agli spazi dei nomi. Il motivo è che uno spazio dei nomi può estendersi su più assembly e non tutti gli assembly devono essere caricati contemporaneamente.

Il compilatore elabora qualsiasi tag XML valido. I tag seguenti forniscono funzionalità di uso comune nella documentazione dell'utente.

• <c>
• <codice>
• <esempio>
• <eccezione>¹
• <includere>¹
• <lista>
• <Para>
• <param>¹
• <paramref>
• <autorizzazione>¹
• <osservazioni>
• <rendiconto>
• <vedere>¹
• <seealso>¹
• <sommario>
• <typeparam>¹
• <typeparamref>
• <valore>

(¹ Il compilatore verifica la sintassi.

Annotazioni

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>.

Vedere anche

• Documentare il codice con XML
• -documento
• Procedura: Creare la documentazione XML