Condividi tramite

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)

  • Articolo

Aggiornamento: novembre 2007

Il compilatore Visual Basic può elaborare in un file XML i commenti per la creazione della documentazione presenti nel codice. Per elaborare il file XML nella documentazione è possibile utilizzare strumenti aggiuntivi.

I commenti XML sono consentiti su determinati costrutti del codice, ad esempio i tipi e i membri dei tipi. Per i tipi parziali, solo una parte del tipo può contenere commenti XML, anche se non vi sono restrizioni in merito ai commenti sui relativi membri.

Nota:

Non è possibile applicare commenti relativi alla documentazione agli spazi dei nomi, in quanto uno spazio dei nomi può estendersi su diversi assembly e non tutti gli assembly vengono caricati contemporaneamente.

Il compilatore elabora tutti i tag validi per XML. I tag riportati di seguito forniscono le funzionalità più comunemente utilizzate nella documentazione per l'utente.

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<typeparam>1

<value>

(1 Il compilatore verifica la sintassi).

Nota:

Se si desidera che nel testo di un commento relativo alla documentazione vengano visualizzate parentesi angolari, utilizzare &lt; e &gt;. La stringa "&lt;text in angle brackets&gt;", ad esempio, verrà visualizzata come <text in anglebrackets>.

Vedere anche

Attività

Procedura: creare documentazione XLM in Visual Basic

Concetti

Documentazione del codice tramite XML (Visual Basic)

Riferimenti

/doc