Condividi tramite

Documentare il codice tramite XML (Visual Basic)

  • Articolo

In Visual Basic è possibile documentare il codice usando XML.

Commenti relativi alla documentazione XML

Visual Basic offre un modo semplice per creare automaticamente la documentazione XML per i progetti. È possibile generare automaticamente uno scheletro XML per i tipi e i membri per poi fornire riepiloghi, documentazione descrittiva per ogni parametro e altre osservazioni. Con l'installazione appropriata, la documentazione XML viene generata automaticamente in un file XML con lo stesso nome di file radice del progetto. Per informazioni sulla configurazione della generazione del file di documentazione XML, vedere l'opzione del compilatore -doc e la proprietà MSBuild GenerateDocumentationFile.

Il file XML può essere utilizzato o modificato in altro modo come XML. Questo file si trova nella stessa directory del file di output .exe o .dll del progetto.

La documentazione XML inizia con '''. L'elaborazione di questi commenti presenta alcune restrizioni:

  • La documentazione deve essere in codice XML ben formato. Se il codice XML non è ben formato, viene generato un avviso e il file di documentazione conterrà un commento che segnalerà che si è verificato un errore.

  • Gli sviluppatori sono liberi di creare set di tag personalizzati. È disponibile un set consigliato di tag (vedere Tag di commento XML). Alcuni tag consigliati hanno un significato speciale:

    • Il tag <param> viene usato per descrivere i parametri. Se usato, il compilatore verifica che il parametro esista e che tutti i parametri siano descritti nella documentazione. Se la verifica ha esito negativo, il compilatore genera un avviso.

    • L'attributo cref può essere associato a qualsiasi tag per fornire un riferimento a un elemento del codice. Il compilatore verifica l'esistenza di questo elemento. Se la verifica ha esito negativo, il compilatore genera un avviso. Il compilatore rispetta anche le istruzioni Imports quando si cerca un tipo descritto nell'attributo cref.

    • Il tag <riepilogo> è usato da IntelliSense all'interno di Visual Studio per visualizzare altre informazioni su un tipo o su un membro.

Per informazioni dettagliate sulla creazione di un file XML con i commenti della documentazione, vedere gli argomenti seguenti:

Vedi anche