Πώς να χρησιμοποιήσετε Doxygen να γράψει Κώδικες Πηγή

πηγαίο κώδικα Κρατώντας διατηρήσιμη είναι μία από τις πιο δύσκολες προκλήσεις που αντιμετωπίζει κάθε προγραμματιστής λογισμικού, είτε ένας μοναχικός λύκος προγραμματιστής ή ένα μέλος μιας μεγάλης ομάδας . Doxygen σας επιτρέπει να δημιουργήσετε έγγραφα αυτόματα από C + + , Java , ή άλλο κωδικό . Θα αναλύσει παράνομους κωδικό σας και να γράψετε βασική τεκμηρίωση , και μπορείτε να προσθέσετε ειδικά διαμορφωμένη σχόλια στον πηγαίο κώδικα σας για να κάνουν χρήσιμες προσθήκες στο παραγόμενο κώδικα πηγής . Τα πράγματα που θα χρειαστείτε
πηγαίο κώδικα
επεξεργασίας κειμένου
Η Εμφάνιση Περισσότερες οδηγίες
Η

1 Κατεβάστε και εγκαταστήστε Doxygen . Είναι διαθέσιμο σε stack.nl /~ dimitri /doxygen /download.html # latestsrc . 2

Ανοίξτε μια γραμμή εντολών . Στα Windows XP, μπορείτε να το κάνετε αυτό κάνοντας κλικ στο μενού Έναρξη , επιλέγοντας Run , που εισέρχονται "cmd" και κάντε κλικ στο OK . Σε Mac OS , μπορείτε να κάνετε κλικ στο μενού Spotlight , τύπου Terminal , και να επιλέξετε Terminal , όταν εμφανιστεί. Πλοηγηθείτε τη γραμμή εντολών με την πηγή κατάλογο κωδικό σας πληκτρολογώντας " cd " ακολουθούμενο από το όνομα του καταλόγου και πατώντας το πλήκτρο Enter .
Εικόνων 3

Δημιουργία Doxyfile πληκτρολογώντας " doxygen - g " και πατώντας Enter. Αυτό θα δημιουργήσει ένα αρχείο στον τρέχοντα κατάλογο που ονομάζεται " Doxyfile ", το οποίο θα περιέχει όλες τις προεπιλεγμένες επιλογές Doxygen . Μπορείτε να τροποποιήσετε αυτές τις επιλογές ανοίγοντας το Doxyfile σε ένα πρόγραμμα επεξεργασίας κειμένου .
Η 4

σχολιάστε Doxygen στον πηγαίο κώδικα σας . Σχόλια Doxygen είναι φυσιολογικό σχόλια που περιέχουν ειδικούς σχολιασμούς που επιτρέπουν Doxygen να τους βρείτε και να υποδείξει πώς θα πρέπει να τα χρησιμοποιούν . Για παράδειγμα , αν είστε γραπτώς σε γλώσσα C - στυλ , μπορείτε να προσθέσετε μια σύντομη περιγραφή σε μια λειτουργία με την προσθήκη το ακόλουθο σχόλιο πριν από την κήρυξη της :/* ! \\ ενημερώσει σύντομη περιγραφή μου * /Μπορείτε να δείτε όλες τις άλλες σημειώσεις Doxygen υποστηρίζει σε stack.nl /~ dimitri /doxygen /docblocks.html .
5

Τύπος " doxygen Doxyfile " στη γραμμή εντολών και πατήστε Enter . Αυτό θα δημιουργήσει την τεκμηρίωση για τον πηγαίο κώδικα σας .
Η
εικόνων