Δημιουργία Javadoc

Ο οδηγός Ανοίγει τον οδηγό Javadoc Δημιουργία Javadoc σας επιτρέπει τη δημιουργία Javadoc. Αποτελεί ένα περιβάλλον χρήστη για το εργαλείο javadoc.exe που διατίθεται στο Java JDK. Επισκεφθείτε τη σελίδα Sun's Javadoc Tool για μια πλήρη τεκμηρίωση του εργαλείου Javadoc.

Πρώτη σελίδα

Επιλογή είδους:

Επιλογή

Περιγραφή

Εντολή Javadoc

Καθορίστε την εντολή που θα χρησιμοποιηθεί για τη δημιουργία του javadoc.

Επιλέξτε τα είδη για τα οποία θα δημιουργηθεί Javadoc

Στη λίστα, επιλέξτε ή αποεπιλέξτε τα πλαίσια για να καθορίσετε τα είδη που θέλετε να εξαγάγετε. Οι αρχικές τιμές της λίστας αυτής βασίζονται στην επιλογή του πάγκου εργασίας.

Δημιουργία Javadoc για μέλη με ορατότητα

  • Ιδιωτική: Θα τεκμηριωθούν όλα τα μέλη
  • Πακέτο: Θα τεκμηριωθούν μόνο τα μέλη που διαθέτουν προεπιλεγμένη, προστατευμένη ή δημόσια ορατότητα
  • Προστατευμένη: Θα τεκμηριωθούν μόνο τα μέλη που διαθέτουν προστατευμένη ή δημόσια ορατότητα
  • Δημόσια: Θα τεκμηριωθούν μόνο τα μέλη με δημόσια ορατότητα (προεπιλογή)


Χρήση βασικού doclet

Έναρξη της εντολής Javadoc με το βασικό doclet (προεπιλογή) 

  • Προορισμός: επιλέξτε τον προορισμό στον οποίο το βασικό doclet θα εγγράψει την τεκμηρίωση που θα δημιουργηθεί. Ο προορισμός είναι ένα συγκεκριμένο όρισμα doclet και επομένως δεν είναι ενεργοποιημένος όταν χρησιμοποιείτε προσαρμοσμένο doclet.


Χρήση προσαρμοσμένου doclet

Χρήση ενός προσαρμοσμένου doclet για τη δημιουργία τεκμηρίωσης 

  • Όνομα doclet: Πλήρες όνομα είδους του doclet
  • Διαδρομή κλάσεων doclet: Διαδρομή κλάσεων που απαιτείται από την κλάση doclet


Ορίσματα βασικού doclet

Ορίσματα βασικού doclet (διατίθενται όταν έχει επιλεγεί Χρήση βασικού doclet):

Επιλογή

Περιγραφή

Τίτλος εγγράφου

Καθορίστε έναν τίτλο εγγράφου.
Δημιουργία σελίδας χρήσης Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να περιέχεται μια σελίδα "Χρήση" στην τεκμηρίωση.
Δημιουργία διακλάδωσης ιεραρχίας Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να περιέχεται μια σελίδα "Διακλάδωση" στην τεκμηρίωση.

Δημιουργία γραμμής πλοήγησης

Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να περιέχεται μια γραμμή πλοήγησης (κεφαλίδα και υποσέλιδο) στην τεκμηρίωση.
Δημιουργία ευρετηρίου Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να περιέχεται μια σελίδα "Ευρετήριο" στην τεκμηρίωση.
Διαχωρισμός ευρετηρίου ανά γράμμα Δημιουργία ευρετηρίου ανά γράμμα. Ενεργοποιείται όταν έχετε επιλέξει Δημιουργία ευρετηρίου. 
@author Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να γίνει τεκμηρίωση του προσδιοριστικού @author.
@version Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να γίνει τεκμηρίωση του προσδιοριστικού @version.
@deprecated Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να γίνει τεκμηρίωση του προσδιοριστικού @deprecated.
λίστα καταργημένων στοιχείων Ενεργοποιήστε αυτή την επιλογή αν επιθυμείτε να περιέχεται μια σελίδα "Καταργημένα στοιχεία" στην τεκμηρίωση. Ενεργοποιείται όταν έχετε επιλέξει @deprecated.
Επιλογή αρχείων αποθήκευσης στα οποία γίνεται παραπομπή και έργων προς στα οποία θα πρέπει να δημιουργηθούν διασυνδέσεις Καθορίστε σε ποια άλλη τεκμηρίωση το Javadoc θα πρέπει να δημιουργήσει διασυνδέσεις όταν γίνεται παραπομπή σε άλλα είδη. 
  • Επιλογή όλων: Δημιουργία διασυνδέσεων προς όλες τις άλλες θέσεις τεκμηρίωσης
  • Εκκαθάριση όλων: Δεν δημιουργούνται διασυνδέσεις προς άλλες θέσεις τεκμηρίωσης
  • Ρύθμιση: Ρύθμιση της θέσης Javadoc ενός JAR ή ενός έργου στα οποία γίνεται παραπομπή.
Φύλλο στυλ Επιλέξτε το φύλλο στυλ που θα χρησιμοποιηθεί

Γενικά ορίσματα

Γενικές επιλογές Javadoc:

Επιλογή

Περιγραφή

Επισκόπηση

Καθορίζει ότι το Javadoc πρέπει να ανακτά το κείμενο για την τεκμηρίωση επισκόπησης από το δεδομένο αρχείο. Θα τοποθετηθεί στο overview-summary.html.

Επιλογές VM

Προσθέστε οποιονδήποτε αριθμό επιπλέον επιλογών VM.

Πρόσθετες επιλογές Javadoc

Προσθέστε οποιονδήποτε αριθμό επιπλέον επιλογών: Επιλογές προσαρμοσμένου doclet ή επιλογές συμβατότητας JRE 1.4.
Σημειώστε ότι τα ορίσματα που περιέχουν κενά διαστήματα πρέπει να περικλείονται σε εισαγωγικά. Για ορίσματα που καθορίζουν κώδικα html (π.χ -header) χρησιμοποιήστε   ή " για να αποφύγετε τα κενά και τα εισαγωγικά.

Συμβατότητα πρωτογενούς κώδικα JRE

Η συμβατότητα πρωτογενούς κώδικα JRE που θα γίνει αποδεκτή από το εργαλείο javadoc.

Αποθήκευση των ρυθμίσεων αυτής της εξαγωγής Javadoc ως σεναρίου Ant

Ορίστε την αποθήκευση ενός σεναρίου Ant το οποίο θα εκτελεί την καθορισμένη εξαγωγή Javadoc χωρίς την ανάγκη χρήσης του οδηγού. Ένα υπάρχον σενάριο Ant μπορεί να τροποποιηθεί με αυτόν τον οδηγό (χρησιμοποιήστε τον οδηγό ανοίγματος Javadoc από το μενού περιβάλλοντος στο σενάριο Ant που δημιουργήθηκε)

Άνοιγμα δημιουργημένου αρχείου ευρετηρίου σε πρόγραμμα πλοήγησης Άνοιγμα του αρχείου index.html που θα δημιουργηθεί στο πρόγραμμα πλοήγησης (διατίθεται μόνο όταν χρησιμοποιείται το βασικό doclet)

Πατήστε Ολοκλήρωση για να αρχίσει η δημιουργία του Javadoc. Αν ο προορισμός είναι διαφορετικός από τη θέση που ρυθμίστηκε στη σελίδα "Θέση Javadoc" του έργου, θα ερωτηθείτε αν επιθυμείτε να ορίσετε το νέο φάκελο προορισμού ως θέση Javadoc του έργου. Έτσι, όλες οι κλήσεις για άνοιγμα εξωτερικού Javadoc θα χρησιμοποιούν την τεκμηρίωση που θα δημιουργηθεί τώρα.

Θα ξεκινήσει μια νέα διεργασία και η δημιουργία θα εκτελείται στο παρασκήνιο. Ανοίξτε την προβολή "Κονσόλα" (Παράθυρο > Εμφάνιση προβολής> Κονσόλα) για να δείτε την πρόοδο και την κατάσταση της δημιουργίας.

Σχετικές παραπομπές

Ενέργειες αρχείων
Ιδιότητες θέσης Javadoc