Aggiunta documentazione per Visual Basic NET ( VB.NET ) progetto è importante in modo che le persone che utilizzano il programma hanno un posto dove trovare ulteriori informazioni sulle caratteristiche 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 . Cose che ti serviranno
Microsoft Visual Studio 2005, 2008 o 2010
Show More Istruzioni
1
Aprire il progetto VB.NET in Microsoft Visual Studio 2005, 2008 o 2010 .
2
individuare il codice per un tipo o un membro che si desidera documentare e posizionare il cursore sulla riga sopra il codice . Un tipo comprende cose come interfaccia o classe. I membri includono cose come una subroutine , funzioni , eventi o proprietà .
3
Aggiungi '' ' ( 3 caratteri virgolette ) all'inizio della riga. Questa specifica una linea di documentazione . L'editor di codice aggiungerà una struttura XML corrispondenti agli elementi sulla linea sotto di esso .
4
Aggiungi la documentazione come testo tra i tag XML . E 'possibile aggiungere nuovo commento Tags documentazione XML modificando il file " VBXMLDoc.xml " con un editor di testo . Il file si trova nella " Application Data" di Visual Studio o la cartella " AppData " .
5
Aggiungere eventuali linee in più di codice con i commenti di documentazione XML che utilizzano il tipo di membro . Un tag mostrerà ulteriori informazioni sul tipo di membro .
6 Clicca il tuo progetto in Esplora soluzioni. Fare clic sul menu "Progetto" e fare clic su " Proprietà". Fare clic sulla scheda "Compila" e aggiungere " /doc " nella casella "Generate XML documentazione file" . Questo dice al compilatore di creare un file XML quando si compila il progetto .
7
Crea un file di documentazione XML mediante la compilazione del progetto VB.NET . Il file verrà visualizzato nella stessa cartella . Exe o il file . Dll .
