Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
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, quindi 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 tuo progetto.
La documentazione XML inizia con '''. L'elaborazione di questi commenti presenta alcune restrizioni:
La documentazione deve essere xml ben formato. Se il formato XML non è corretto, viene generato un avviso e il file della documentazione contiene un commento che indica che è stato rilevato un errore.
Gli sviluppatori sono liberi di creare un proprio set di tag. È 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 verificherà che il parametro esista e che tutti i parametri siano descritti nella documentazione. Se la verifica non riesce, il compilatore genera un avviso.L'attributo
crefpuò essere associato a qualsiasi tag per fornire un riferimento a un elemento del codice. Il compilatore verifica che questo elemento di codice esista. Se la verifica non riesce, il compilatore genera un avviso. Il compilatore rispetta anche leImportsistruzioni quando si cerca un tipo descritto nell'attributocref.Il
<summary>tag viene usato da IntelliSense in Visual Studio per visualizzare informazioni aggiuntive su un tipo o un membro.
Sezioni correlate
Per informazioni dettagliate sulla creazione di un file XML con commenti relativi alla documentazione, vedere gli argomenti seguenti:
Vedere anche
Collabora con noi su GitHub
L'origine di questo contenuto è disponibile in GitHub, in cui è anche possibile creare ed esaminare i problemi e le richieste pull. Per ulteriori informazioni, vedere la guida per i collaboratori.
