Condividi tramite

Procedura: Creare la documentazione XML in Visual Basic

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

Annotazioni

Il computer potrebbe visualizzare nomi o percorsi diversi per alcuni degli elementi dell'interfaccia utente di Visual Studio nelle istruzioni seguenti. L'edizione di Visual Studio disponibile e le impostazioni usate 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. Tipo ''' (tre virgolette singole).

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

  3. Aggiungere informazioni descrittive tra i tag appropriati.

    Annotazioni

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

  4. Aggiungere codice aggiuntivo 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.

Vedere anche