JSDoc

JSDoc μπορεί να παράγει έγγραφα σε μια ευρεία σειρά που βασίζεται σε κείμενο μορφές όπως HTML, XML, JSON, και ούτω καθεξής.

JSDoc στο παρελθόν ήταν γνωστή ως JsDoc Toolkit.

Οι προηγούμενες εκδόσεις της Java JSDoc χρησιμοποιείται για να αναλύσει τον πηγαίο κώδικα, εξαγάγετε τα σχόλια και να δημιουργήσουν την τεκμηρίωση. Από το υποκατάστημα 3.x Node.js χρησιμοποιείται αντ 'αυτού.

Εκτός από Node.js, JSDoc μπορεί επίσης να λειτουργήσει με Rhino κινητήρα του Mozilla, καθώς και.

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

Τι είναι καινούργιο σε αυτή την έκδοση:.

• Μπορεί να τρέξει τώρα JSDoc για Node.js
• Μπορεί να χρησιμοποιήσει τώρα ταinterface καιimplements ετικέτες για να τεκμηριώσουν τις διασυνδέσεις και τις εφαρμογές τους.
• inheritDoc καιoverride ετικέτες Λήξη Compiler είναι τώρα υποστηρίζονται.
• Αν το σχόλιο JSDoc για ένα σύμβολο περιλαμβάνει την ετικέταmixes, όλα τα mixins τώρα εμφανίζονται στην τεκμηρίωση του συμβόλου.
• JSDoc μπορεί τώρα να συνδεθεί πληροφορίες στην κονσόλα καθώς λειτουργεί (για παράδειγμα, το όνομα του κάθε αρχείου που αναλύει JSDoc). Για να συνδεθείτε αυτές τις πληροφορίες, εκτελέστε JSDoc με την --verbose σημαία.
• Μπορεί πλέον να χρησιμοποιούν οποιοδήποτε αρχείο ως πακέτο ή αρχείο README για την τεκμηρίωση σας. Χρησιμοποιήστε τα / -P - πακέτο και / -R / -. Σημαίες README για να καθορίσετε το αρχείο του πακέτου και README
• τυπογραφία και χρωμάτων Το προεπιλεγμένο πρότυπο έχουν βελτιωθεί σημαντικά.

Τι είναι καινούργιο στην έκδοση 3.3.2:

• Μπορεί να τρέξει τώρα JSDoc για Node.js.
• Μπορεί να χρησιμοποιήσει τώρα ταinterface καιimplements ετικέτες για να τεκμηριώσουν τις διασυνδέσεις και τις εφαρμογές τους.
• inheritDoc καιoverride ετικέτες Λήξη Compiler είναι τώρα υποστηρίζονται.
• Αν το σχόλιο JSDoc για ένα σύμβολο περιλαμβάνει την ετικέταmixes, όλα τα mixins τώρα εμφανίζονται στην τεκμηρίωση του συμβόλου.
• JSDoc μπορεί τώρα να συνδεθεί πληροφορίες στην κονσόλα καθώς λειτουργεί (για παράδειγμα, το όνομα του κάθε αρχείου που αναλύει JSDoc). Για να συνδεθείτε αυτές τις πληροφορίες, εκτελέστε JSDoc με την --verbose σημαία.
• Μπορεί πλέον να χρησιμοποιούν οποιοδήποτε αρχείο ως πακέτο ή αρχείο README για την τεκμηρίωση σας. Χρησιμοποιήστε τα / -P - πακέτο και / -R / -. Σημαίες README για να καθορίσετε το αρχείο του πακέτου και README
• τυπογραφία και χρωμάτων Το προεπιλεγμένο πρότυπο έχουν βελτιωθεί σημαντικά.

Τι είναι καινούργιο στην έκδοση 3.3.0:

• Μπορεί να τρέξει τώρα JSDoc για Node.js.
• Μπορεί να χρησιμοποιήσει τώρα ταinterface καιimplements ετικέτες για να τεκμηριώσουν τις διασυνδέσεις και τις εφαρμογές τους.
• inheritDoc καιoverride ετικέτες Λήξη Compiler είναι τώρα υποστηρίζονται.
• Αν το σχόλιο JSDoc για ένα σύμβολο περιλαμβάνει την ετικέταmixes, όλα τα mixins τώρα εμφανίζονται στην τεκμηρίωση του συμβόλου.
• JSDoc μπορεί τώρα να συνδεθεί πληροφορίες στην κονσόλα καθώς λειτουργεί (για παράδειγμα, το όνομα του κάθε αρχείου που αναλύει JSDoc). Για να συνδεθείτε αυτές τις πληροφορίες, εκτελέστε JSDoc με την --verbose σημαία.
• Μπορεί πλέον να χρησιμοποιούν οποιοδήποτε αρχείο ως πακέτο ή αρχείο README για την τεκμηρίωση σας. Χρησιμοποιήστε τα / -P - πακέτο και / -R / -. Σημαίες README για να καθορίσετε το αρχείο του πακέτου και README
• τυπογραφία και χρωμάτων Το προεπιλεγμένο πρότυπο έχουν βελτιωθεί σημαντικά.

Τι είναι καινούργιο στην έκδοση 3.2.2 / 3.3.0-beta1:

• Απευθύνεται σε οπισθοδρόμηση JSDoc 3.2.1 που θα μπορούσε να αποτρέψει μια δήλωση της συνάρτησης από σκίαση δήλωση με το ίδιο όνομα σε ένα εξωτερικό πεδίο.
• Αν μια κλάση-παιδί υπερισχύει μια μέθοδο σε μια κλάση γονέα, χωρίς να τεκμηριώνουν τη μέθοδο που έχουν παρακαμφθεί, τεκμηρίωση της μεθόδου έχει αντιγραφεί από τη μητρική κατηγορία.
• Μπορείτε να χρησιμοποιήσετε τώρα inline ετικέτες HTML στο Markdown-μορφοποιημένο κείμενο. Επιπλέον, JSDoc τώρα χρησιμοποιεί μόνο την έντονη Markdown αναλυτή? το markdown-JS parser έχει αφαιρεθεί.

εκφράσεις
• Τύπος μπορεί να περιλαμβάνει τώρα ένα πολύ ευρύτερο φάσμα των τύπων επαναλαμβανόμενη. Επιπλέον, μπορείτε τώρα να χρησιμοποιήσετε nullable και μη nullable τροποποιητές Λήξη Compiler με επαναλαμβανόμενες μορφές. Για παράδειγμα, η έκφραση του τύπου ...! Εγχόρδων (α επαναλαμβανόμενη, μη-nullable χορδή) είναι πλέον αναλύεται σωστά.

Τι είναι καινούργιο στην έκδοση 2.4.0:

• Διορθώθηκε το bug που προστίθεται πολλαπλές σύμβολα με το ίδιο όνομα να docs.
• Προστέθηκε υποστήριξη για την επιλογή -m για να καταστείλει τις προειδοποιήσεις για πολλαπλές docs.
• Προστέθηκε επίθεμα από brownsea42 να υποστηρίξει εισηγμένες μεταβλητές χρήστη στη γραμμή εντολών.
• Διορθώθηκε το bug που προκάλεσε ενίοτε συνδέσμους προς τα γεγονότα να είναι λανθασμένη.

Απαιτήσεις :

• για να ενεργοποιήσετε την Javascript πλευρά του client
• Node.js 0.10 ή υψηλότερη