Προγραμματισμός

Νέα τεκμηρίωση Java Java SE 7 Javadoc

Στην τελευταία μου ανάρτηση, αναφέρθηκα εν συντομία στην ανάρτηση του Jonathan Gibbons What Up, JavaDoc; που περιγράφει μερικές πρόσφατες αλλαγές στο Javadoc, συμπεριλαμβανομένων αλλαγών που επιτρέπουν την εφαρμογή ενός φύλλου στυλ CSS στην τεκμηρίωση. Δημοσίευση του Mark Reinhold JDK 7: Είμαστε ακόμα εκεί; μιλά για τις αλλαγές στο προεπιλεγμένο στυλ εμφάνισης του Java SE 7 API. Σε αυτήν την ανάρτηση, εξετάζω εν συντομία αυτήν την αλλαγή.

Τα επόμενα δύο στιγμιότυπα οθόνης δείχνουν την παραδοσιακή προεπιλεγμένη εμφάνιση της τεκμηρίωσης Javadoc που έχουμε δει εδώ και χρόνια και στη συνέχεια δείχνουν τη νέα προεπιλεγμένη εμφάνιση.

Αυτό το προεπιλεγμένο στυλ δεν περιορίζεται στην τυπική τεκμηρίωση SDK API. Χρησιμοποιείται επίσης για τη δημιουργία προσαρμοσμένου Javadoc για άλλες εφαρμογές Java. Το επόμενο στιγμιότυπο οθόνης δείχνει ότι ο Javadoc καλείται μέσω Ant χρησιμοποιώντας το JDK 7 build 146 (το build υποστηρίζει το νέο στυλ). Το παράδειγμα που δημιουργήθηκε σε αυτήν την περίπτωση είναι ο κωδικός από την ανάρτησή μου.

Όπως δείχνει το στιγμιότυπο οθόνης, δεν έκανα κάτι ιδιαίτερο για να εφαρμόσω το νέο στυλ. Ωστόσο, η έξοδος είναι νέα (και νομίζω ότι βελτιώθηκε) όπως φαίνεται στα επόμενα στιγμιότυπα δύο ζευγών.

Ο κατάλογος Javadoc που δημιουργήθηκε περιλαμβάνει ένα αρχείο που ονομάζεται stylesheet.css. Αυτό το αρχείο κειμένου μπορεί να αλλάξει για να αλλάξει εύκολα την εμφάνιση. Το επόμενο στιγμιότυπο οθόνης δείχνει πώς φαίνεται όταν αλλάζω το .rowColor, .altColor, και το χρώμα του φόντου απο σώμα.

Δεν προτείνω τα χρώματα στο παραπάνω στιγμιότυπο οθόνης. προορίζονται απλώς να δείξουν πόσο εύκολο είναι να αλλάξουν την εμφάνιση της παρουσίασης.

συμπέρασμα

Μου αρέσει το νέο προεπιλεγμένο στυλ και έρχεται "εκτός κουτιού" χωρίς νέα προσπάθεια από το JDK 7 build 146. Αυτό είναι μόνο μια μικρή και σε μεγάλο βαθμό αισθητική βελτίωση, αλλά είναι ωστόσο ευπρόσδεκτο.

Η αρχική ανάρτηση διατίθεται στη διεύθυνση //marxsoftware.blogspot.com/ (Εμπνευσμένη από τις πραγματικές εκδηλώσεις)

Αυτή η ιστορία, "New Java SE 7 Javadoc API Documentation Appearance" δημοσιεύθηκε αρχικά από το JavaWorld.