Πώς να δημιουργήσετε Vb.Net Τεκμηρίωση

. Προσθέτοντας τεκμηρίωση σε Visual Basic NET σας ( VB.NET ) έργο είναι σημαντικό , έτσι ώστε τα άτομα που χρησιμοποιούν το πρόγραμμά σας έχει μια θέση για να βρείτε περισσότερες πληροφορίες σχετικά με τις δυνατότητες που έχουν πρόβλημα με. Visual Studio χρησιμοποιεί '' ' για να δηλώσει μια γραμμή τεκμηρίωσης, το οποίο δημιουργεί αυτόματα ένα πρότυπο XML για . Όταν καταρτίζουν το έργο σας , το Visual Studio θα δημιουργήσει ένα αρχείο XML από όλα τα σχόλια τεκμηρίωση. Τα πράγματα που θα χρειαστείτε για Microsoft Visual Studio 2005 , 2008 ή 2010
Η Εμφάνιση Περισσότερες οδηγίες
Η

1 Ανοίξτε το έργο σας VB.NET στο Microsoft Visual Studio 2005 , 2008 ή 2010 . 2

Εντοπίστε τον κωδικό για έναν τύπο ή το στοιχείο που θέλετε να τεκμηριώσει και να τοποθετήσετε τον κέρσορα στη γραμμή πάνω από τον κώδικα . Ένας τύπος περιλαμβάνει τα πράγματα όπως μια διεπαφή ή την τάξη. Μέλη περιλαμβάνουν τα πράγματα όπως μια υπορουτίνα , λειτουργία , εκδήλωση ή την ιδιοκτησία .
Εικόνων 3

Προσθήκη '' ' ( 3 μονά εισαγωγικά χαρακτήρες ) στην αρχή της γραμμής . Αυτό ορίζει μια γραμμή τεκμηρίωσης . Ο κώδικας Editor θα προσθέσει ένα σκελετό XML που αντιστοιχούν στα στοιχεία στη γραμμή κάτω από αυτή .
Η 4

Προσθέστε τα έγγραφα σας ως κείμενο μεταξύ των ετικετών XML . Είναι δυνατόν να προστεθούν νέες XML Documentation Σχόλιο ετικέτες με την επεξεργασία του αρχείου " VBXMLDOC.xml » με ένα πρόγραμμα επεξεργασίας κειμένου . Το αρχείο βρίσκεται στο φάκελο ή Visual Studio του " Δεδομένα εφαρμογής " " AppData " .
5

Προσθέστε τυχόν επιπλέον γραμμές κώδικα με τις παρατηρήσεις έγγραφα XML που χρησιμοποιούν τον τύπο ή το μέλος . Μια

ετικέτα θα δείξει πρόσθετες πληροφορίες σχετικά με τον τύπο ή το μέλος .
Η 6

Κάντε κλικ έργο σας για την Εξερεύνηση λύση . Κάντε κλικ στο μενού "Έργο" και κάντε κλικ στο " Ιδιότητες". Κάντε κλικ στην καρτέλα " Compile " και πρόσθεσε " /doc " στο "Δημιουργία XML αρχείο τεκμηρίωσης " κουτί . Αυτό λέει στον compiler να δημιουργήσετε ένα αρχείο XML κατά τη μεταγλώττιση του έργου .
Η 7

Δημιουργήστε ένα αρχείο XML έγγραφα με την κατάρτιση του σχεδίου σας VB.NET . Το αρχείο θα εμφανιστεί στον ίδιο φάκελο με το . Exe ή . Dll αρχείο .
Η
εικόνων