Πώς να δημιουργήσετε Javadoc Όταν Σχολιάζοντας

Javadoc είναι το de facto πρότυπο για τη δημιουργία τεκμηρίωσης από τον πηγαίο κώδικα . Είναι ένα εργαλείο για να δημιουργήσετε έγγραφα HTML από το ειδικά διαμορφωμένο σχόλια σε κώδικα Java . Αυτό μπορεί να χρησιμοποιηθεί για τη δημιουργία δομημένων διεπαφή προγραμματισμού εφαρμογών ( API ) τεκμηρίωση αυτόματα , να δώσει μερικές συμβουλές για το IDE ή για την ανάθεση πακέτα , κλάσεις και μεθόδους . Ουσιαστικά, είναι ένας τρόπος για να σχολιάζει τις περιγραφές των παραμέτρων , ο οποίος έγραψε τι και ποιος φταίει αν χαλάσει. Java έρχεται με το javadoc πρόγραμμα γραμμής εντολών για να δημιουργήσει την τεκμηρίωση HTML , αλλά οι περισσότεροι Java ολοκληρωμένα περιβάλλοντα ανάπτυξης ( IDEs ) έχουν επίσης αυτό το ολοκληρωμένο . Οδηγίες
Η 1

Δημιουργία ειδικών σχόλια javadoc . Για να υποδηλώσει ένα σχόλιο javadoc , ξεκινήστε με το σχόλιο /** . Σχόλια Javadoc υπάρχουν συνήθως στην κορυφή ενός αρχείου , πριν τάξεις και πριν από τις μεθόδους . Δεδομένου ότι είναι σχεδιασμένο για πλήρη τεκμηρίωση API , δεν είναι ασυνήθιστο να δει τα αρχεία με περισσότερα σχόλια javadoc από τον κωδικό . "" /*** Αυτό είναι ένα σχόλιο javadoc . Δεν έχει κανένα javadoc meta -tags ακόμα, αλλά δεν ενεργοποιούν το parser javadoc να ρίξετε μια ματιά σε αυτό το σχόλιο . * /" " 2

Προσθήκη API meta - tags ( ετικέτες που περιγράφουν το ίδιο το API ) , όταν σχολιάζοντας . Ετικέτες API είναι τα ονόματα των παραμέτρων , οι περιγραφές , τα προφίλ εξαίρεση, περιγραφές τιμή επιστροφής , τα ονόματα και τις περιγραφές μέθοδο μέθοδο . Πολλοί IDEs ενσωματώνουν αυτά τα δεδομένα σε συμβουλές εργαλείων τους και άλλοι βοηθοί , καθώς και να είναι για χρήση σε HTML ή σε μορφή σχολίου .
Εικόνων 3

Χρησιμοποιήστε την περιγραφή της μεθόδου . Αυτή η μετα - ετικέτα δεν έχει όνομα ετικέτας : Είναι απλά το σχόλιο που έρχεται πριν από τις άλλες ετικέτες " " /*** Υπολογίζει την κλίση μιας γραμμής . . * /" "
Η 4

Ενσωματώστε περιγραφές των παραμέτρων . Αυτά συμβολίζονται με τους @ param μετα- ετικέτες, οι οποίες θα πρέπει να ακολουθείται από το όνομα της παραμέτρου και την περιγραφή . "" /*** Υπολογίζει την κλίση μιας γραμμής . ** @ Param p1 Πρώτο σημείο που περιγράφει τη γραμμή * @ param p2 Δεύτερο σημείο που περιγράφει τη γραμμή * /" "
5

Επιστροφή περιγραφές αξία . Αυτό συμβολίζεται με το @ επιστροφή μετα - ετικέτα και θα πρέπει να ακολουθείται από μια περιγραφή της αξίας ή επιστροφής . "" /*** Υπολογίζει την κλίση μιας γραμμής . ** @ Param p1 Πρώτο σημείο που περιγράφει τη γραμμή * @ param p2 Δεύτερο σημείο που περιγράφει τη γραμμή * @ επιστροφή Κλίση της γραμμής ως float * /" "
Η 6

Προσθέστε ετικέτες απόδοση . Οι ετικέτες αποδίδουν τον κώδικα σε ένα συγκεκριμένο συντάκτη . "" /*** Υπολογίζει την κλίση μιας γραμμής . @ ** Συγγραφέας Jack Smith * @ param p1 Πρώτο σημείο που περιγράφει τη γραμμή * @ param p2 Δεύτερο σημείο που περιγράφει τη γραμμή Slope * @ επιστροφή της γραμμής ως float * /" "
Η 7

Δημιουργήστε την τεκμηρίωση HTML . Αν δεν είστε χρησιμοποιώντας ένα IDE ή απλά θέλετε να το κάνετε μόνοι σας , μπορείτε να εκτελέσετε το πρόγραμμα γραμμής εντολών javadoc από τον κατάλογο του έργου σας . Καθορίστε τον κατάλογο εξόδου με το διακόπτη -d και να περάσει μια λίστα με τα αρχεία. Java ( συνήθως ως μπαλαντέρ ) . "" Javadoc -d docs * . Java ""

Η