Ο οδηγός
Δημιουργία Javadoc σας επιτρέπει τη δημιουργία Javadoc. Αποτελεί ένα
περιβάλλον χρήστη για το εργαλείο javadoc.exe που διατίθεται στο Java JDK. Επισκεφθείτε τη σελίδα Sun's Javadoc Tool για μια πλήρη τεκμηρίωση του εργαλείου Javadoc.
Επιλογή είδους:
Επιλογή |
Περιγραφή |
---|---|
Επιλογή ειδών για τα οποία θα δημιουργηθεί Javadoc |
Στη λίστα, επιλέξτε ή διαγράψτε τα πλαίσια για να προσδιορίσετε με ακρίβεια τα είδη τα οποία θέλετε να εξάγετε στο αρχείο JAR. Η απόδοση αρχικών τιμών της λίστας αυτής γίνεται με την επιλογή του πάγκου εργασίας. Είναι δυνατή η επιλογή μόνο ενός έργου κάθε φορά, καθώς μόνο μια διαδρομή κλάσης έργου μπορεί να χρησιμοποιηθεί κάθε φορά, όταν εκτελείται το εργαλείο Javadoc. |
Δημιουργία Javadoc για μέλη με ορατότητα |
|
Χρήση τυπικού doclet |
Έναρξη της εντολής Javadoc με το τυπικό doclet (προεπιλογή)
|
Χρήση προσαρμοσμένου doclet |
Χρήση ενός προσαρμοσμένου doclet για τη δημιουργία τεκμηρίωσης
|
Ορίσματα τυπικού doclet (διατίθενται όταν έχει επιλεγεί το Χρήση τυπικού doclet):
Επιλογή |
Περιγραφή |
---|---|
Τίτλος εγγράφου |
Καθορίζει ένα τίτλο εγγράφου. |
Δημιουργία σελίδας χρήσης | Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να περιέχεται μια σελίδα "Χρήση" στην τεκμηρίωση. |
Δημιουργία διακλάδωσης ιεραρχίας | Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να περιέχεται μια σελίδα "Διακλάδωση" στην τεκμηρίωση. |
Δημιουργία γραμμής λειτουργίας πλοήγησης |
Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να περιέχεται μια γραμμή πλοήγησης στην τεκμηρίωση. |
Δημιουργία ευρετηρίου | Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να περιέχεται μια σελίδα "Ευρετήριο" στην τεκμηρίωση. |
Δημιουργία ευρετηρίου ανά γράμμα | Δημιουργία ευρετηρίου ανά γράμμα. Ενεργοποιείτε όταν είναι επιλεγμένο το Δημιουργία ευρετηρίου. |
@author | Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να γίνει τεκμηρίωση του προσδιοριστικού @author. |
@version | Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να γίνει τεκμηρίωση του προσδιοριστικού @version. |
@deprecated | Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να γίνει τεκμηρίωση του προσδιοριστικού @deprecated. |
λίστα με τα καταργημένα στοιχεία | Πραγματοποιήστε αυτή την επιλογή εάν επιθυμείτε να περιέχεται μια σελίδα "Καταργημένα στοιχεία" στην τεκμηρίωση. Ενεργοποιείται όταν είναι επιλεγμένη η επιλογή @deprecated. |
Επιλογή κλάσεων στις οποίες γίνεται παραπομπή στις οποίες το Javadoc θα πρέπει να δημιουργήσει διασυνδέσεις |
Καθορίζει σε ποια άλλη τεκμηρίωση το Javadoc θα πρέπει να δημιουργήσει διασυνδέσεις όταν γίνεται παραπομπή σε άλλα είδη.
|
Φύλλο στυλ | Επιλογή του φύλλου στυλ που θα χρησιμοποιηθεί |
Γενικές επιλογές Javadoc
Επιλογή |
Περιγραφή |
---|---|
Επισκόπηση |
Καθορίζει ότι το Javadoc πρέπει να ανακτά το κείμενο για την τεκμηρίωση επισκόπησης από το δεδομένο αρχείο. Θα τοποθετηθεί στο overview-summary.html. |
Πρόσθετες επιλογές Javadoc |
Προσθέστε οποιονδήποτε αριθμό πρόσθετων επιλογών εδώ: Επιλογές προσαρμοσμένου doclet, επιλογές VM ή επιλογές συμβατότητας JRE 1.4. |
Αποθηκεύστε τις ρυθμίσεις αυτής της εξαγωγής Javadoc ως σενάριο Ant. |
Ορίστε να αποθηκεύεται ένα σενάριο Ant το οποίο θα εκτελέσει την καθορισμένη εξαγωγή Javadoc χωρίς την ανάγκη χρήσης του οδηγού. Ένα υπάρχον σενάριο Ant μπορεί να τροποποιηθεί με αυτόν τον οδηγό (χρησιμοποιήστε τον οδηγό ανοίγματος Javadoc από το μενού περιβάλλοντος στο σενάριο Ant που δημιουργήθηκε) |
Άνοιγμα αρχείου ευρετηρίου που δημιουργήθηκε στο πρόγραμμα πλοήγησης | Άνοιγμα του αρχείου index.html που δημιουργήθηκε στο πρόγραμμα πλοήγησης (διατίθεται μόνο όταν χρησιμοποιείται το τυπικό doclet) |
Πατήστε Ολοκλήρωση για την εκκίνηση της δημιουργίας του Javadoc. Εάν ο προορισμός είναι διαφορετικός από τη θέση που ρυθμίστηκε στη σελίδα "Θέση Javadoc" του έργου, θα σας ζητηθεί εάν επιθυμείτε να ορίσετε τη θέση του Javadoc του έργου στο νέο φάκελο προορισμού. Έτσι, όλες οι κλήσεις για άνοιγμα εξωτερικού Javadoc θα χρησιμοποιούν την πρόσφατη δημιουργημένη τεκμηρίωση.
Θα ξεκινήσει μια νέα διεργασία και η δημιουργία θα εκτελείται στο παρασκήνιο. Ανοίξτε την προβολή "Κονσόλα" (Παράθυρο > Εμφάνιση προβολής> Κονσόλα) για να δείτε την πρόοδο και την κατάσταση της δημιουργίας.
Δημιουργία τεκμηρίωσης Javadoc