YUIDoc

YUIDoc είναι η επίσημη γεννήτρια τεκμηρίωση που χρησιμοποιείται από την ομάδα του Yahoo! για τη Yahoo! User Interface 3.x (YUI) σειρά.

Τα έργα app με σάρωση κώδικα Javascript για σχόλια, και τη χρήση τους ως τεκμηρίωση για τον ίδιο τον κώδικα.

YUIDoc μπορεί να χρησιμοποιηθεί για να τεκμηριώνει τις πληροφορίες σχετικά με τις ιδιότητες, έθιμο γεγονότα, τις μεθόδους και την κληρονομιά για JS αντικείμενα.

Εκτός από τη δημιουργία χώρων τεκμηρίωση από τον κώδικα JavaScript, YUIDoc έρχεται επίσης με ένα ενσωματωμένο διακομιστή Web, καθώς και. Αυτό το χαρακτηριστικό είχε συμπεριληφθεί για να επιτρέπει στους προγραμματιστές να προεπισκόπηση sites τεκμηρίωση σε πραγματικό χρόνο, ενώ γράφουν κώδικα και τα σχόλιά τους.

YUIDoc δεν πρέπει να συγχέεται με το YUI & nbsp? Doc , ένα παρόμοιο γεννήτρια τεκμηρίωση από το Yahoo, αλλά γραμμένο κυρίως σε Python

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

• YUIDoc v0.9.0 υποστηρίζει προσαρμοσμένα στοιχεία που τεκμηριώνουν

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

• Σταθερή:
• Εναλλαγή σε αληθινό επιλογές Markdown ως προεπιλεγμένη
• Διορθώστε ένα σφάλμα που κληρονόμησε τάξη αναλυθεί δύο φορές
• Αφαίρεση Εσοχής μέθοδο τιμόνι partials μέσα στην τάξη κατασκευαστής
• Χρησιμοποιήστε logFn διαμόρφωσης για να συνδεθείτε
• Αλλαγή:
• Drop αφαιρεθεί κανόνες JSHint

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

• Αλλαγή:
• Η Markdown parser να markdown-it
• Προσθήκη Node.js v0.12 και io.js σε Travis CI ρύθμιση
• Σταθερή:
• Ένα bug με & quot? @ & quot? δεν escapable στο παράδειγμα

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

• YUIDoc υποστηρίζει ετικέταthrows Τέλος, και περιλαμβάνει περισσότερα συμβατότητα με τιμόνι v2.0, βελτιώσεις και εξαρτήσεις ενημερώσεις.

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

• Υποστηρίζει υπόλοιπο στυλ ES6 παράμετροι σύνταξη για πολλαπλές παραμέτρους
• Επιτρέπει διευθύνσεις URL βάσης για εξωτερικούς συνδέσμους
• Προσθέτει --no-sort επιλογή

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

• Αλλαγή δημιουργία URL απλά να ενταχθούν χορδές

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

• Τροποποίηση linting: Επιτυχής πανί βγαίνει από το CLI, ανεπιτυχής χνούδια εξέρχεται από τη διαδικασία.
• Αλλαγή πανί έτσι ώστε η διαδικασία εξέρχεται μόνο σε περίπτωση αποτυχίας.

Απαιτήσεις :

• Node.js 0.4 ή νεότερη έκδοση