Procedura: creare documentazione XLM in Visual Basic

In questo esempio viene illustrato come aggiungere al codice commenti relativi alla documentazione XLM.

Nota

Nomi o percorsi visualizzati per alcuni elementi dell'interfaccia utente di Visual Studio nelle istruzioni seguenti potrebbero essere diversi nel computer in uso. La versione di Visual Studio in uso e le impostazioni configurate determinano questi elementi. Per altre informazioni vedere Personalizzazione delle impostazioni di sviluppo in Visual Studio.

Per creare la documentazione XML per un tipo o un membro

1. Nell'editor di codice posizionare il cursore sulla riga al di sopra del tipo o del membro per cui si desidera creare la documentazione.

2. Digitare ''' (tre virgolette singole).

   Uno scheletro XML per il tipo o il membro viene aggiunto all'editor di codice.

3. Aggiungere le informazioni descrittive tra i tag appropriati.

   Nota

   Se si aggiungono altre righe all'interno del blocco di documentazione XML, ogni riga deve iniziare con '''.

4. Aggiungere ulteriore codice che utilizza il tipo o il membro con i nuovi commenti relativi alla documentazione XML.

   IntelliSense visualizza il testo dal tag <summary> relativo al tipo o al membro.

5. Compilare il codice per generare un file XML contenente i commenti relativi alla documentazione. Per ulteriori informazioni, vedere /doc.

Vedere anche

Riferimenti

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

/doc

Concetti

Documentazione del codice tramite XML (Visual Basic)