Procedura: creare documentazione XLM in Visual Basic

  • Articolo

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

Nota

I nomi o i 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 dell'IDE.

Per creare la documentazione XML per un tipo o un membro

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

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

    Una bozza XML per il tipo o il membro viene aggiunta nell'editor di codice.

  3. Aggiungere informazioni descrittive tra i tag appropriati.

    Nota

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

  4. Aggiungere codice supplementare che usa il tipo o il membro con i nuovi commenti della documentazione XML.

    IntelliSense visualizza il testo del tag di <riepilogo> per il tipo o il membro.

  5. Compilare il codice per generare un file XML contenente i commenti della documentazione. Per altre informazioni, vedere -doc.

Vedi anche