August 28
Aggiunta la documentazione al progetto di Visual Basic .NET (VB.NET) è importante in modo che le persone che utilizzano il programma hanno un posto per trovare ulteriori informazioni sulle funzioni che stanno avendo problemi con. Visual Studio utilizza '' 'per indicare una linea di documentazione, che crea automaticamente un modello XML per. Quando si compila il progetto, Visual Studio verrà creato un file XML da tutti i vostri commenti di documentazione.
1 Aprire il progetto VB.NET in Microsoft Visual Studio 2005, 2008 o 2010.
2 Individuare il codice di un tipo o di un membro che si desidera documentare e posizionare il cursore sulla riga sopra il codice. Un tipo include cose come un'interfaccia o di classe. I membri includono cose come una subroutine, funzione, l'evento o proprietà.
3 Aggiungere '' '(3 caratteri apici) all'inizio della riga. Questa specifica una linea di documentazione. L'editor di codice aggiungerà uno scheletro XML corrispondenti agli elementi sulla linea sotto di esso.
4 Aggiungi la documentazione come testo tra i tag XML. E 'possibile aggiungere nuovi tag documentazione XML Commento modificando il file "VBXMLDOC.xml" con un editor di testo. Il file si trova nella cartella di Visual Studio "Dati applicazioni" o "AppData".
5 Aggiungere tutte le righe in più di codice con i commenti di documentazione XML che utilizzano il tipo o il membro. Un tag <summary> mostrerà ulteriori informazioni sul tipo o membro.
6 Clicca il tuo progetto sul Solution Explorer. Fare clic sul menu "Progetto" e fare clic su "Proprietà". Fare clic sulla scheda "Compila" e aggiungere "/ doc" nella casella "Crea file di documentazione XML". Questo dice al compilatore di creare un file XML quando si compila il progetto.
7 Creare un file di documentazione XML compilando il progetto VB.NET. Il file verrà visualizzato nella stessa cartella del file exe o dll.