Documentazione del codice tramite XML (Visual Basic)
Aggiornamento: novembre 2007
In Visual Basic è possibile documentare il codice tramite XML
Commenti relativi alla documentazione XML
Visual Basic consente di creare automaticamente la documentazione XML per i progetti. È possibile generare automaticamente uno scheletro XML per i tipi e i membri, quindi fornire i riepiloghi, la documentazione descrittiva per ogni parametro e altre note. Con l'impostazione appropriata, la documentazione XML viene automaticamente generata in un file XML con lo stesso nome del progetto e con estensione XML. Per ulteriori informazioni, vedere /doc.
Il file XML può essere utilizzato o diversamente modificato 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 è regolata da alcune restrizioni:
La documentazione deve essere utilizzare formato XML corretto. Se il formato XML non è corretto, viene visualizzato un messaggio di avviso e nel file di documentazione viene inserito un commento per informare che si è verificato un errore.
Gli sviluppatori sono liberi di creare set di tag personalizzati. Esiste un set di tag consigliato (vedere "Sezioni correlate" in questo argomento). Alcuni dei tag consigliati hanno un significato speciale:
Il tag <param> viene utilizzato per descrivere i parametri. Se utilizzato, il compilatore verifica l'esistenza del parametro e che tutti i parametri siano descritti nella documentazione. Se la verifica ha esito negativo, viene visualizzato un messaggio di avviso.
L'attributo cref può essere associato a qualsiasi tag per fornire un riferimento a un elemento del codice. Il compilatore verifica l'esistenza dell'elemento del codice. Se la verifica ha esito negativo, viene visualizzato un messaggio di avviso. Il compilatore rispetta inoltre eventuali istruzioni Imports quando effettua la ricerca di un tipo descritto nell'attributo cref.
Il tag <summary> è utilizzato da IntelliSense in Visual Studio per visualizzare ulteriori informazioni su un tipo o membro.
Sezioni correlate
Per informazioni dettagliate sulla creazione di un file XML con i commenti relativi, vedere gli argomenti elencati di seguito: