DocumentJS λειτουργεί μέσω του Node.js γραμμής εντολών και επιτρέπει στους προγραμματιστές να δημιουργήσουν χώρους έγγραφα χωρίς να χρειάζεται να κάνει ένα διπλό αγγαρεία της γραφής σχόλια στον κώδικά τους και, στη συνέχεια, εξηγώντας αργότερα σε ένα ξεχωριστό αρχείο HTML.
Η ιστοσελίδα τεκμηρίωσης δημιουργείται χρησιμοποιώντας τον πηγαίο κώδικα του σχολιάζει τον εαυτό τους, όλα αυτόματα αν οι προγραμματιστές ακολουθούν απλές σχόλια κώδικα μορφοποίησης κανόνες.
DocumentJS υποστηρίζει απλές δομές και σύνταξη Markdown, μαζί με τη δυνατότητα να δημιουργήσετε εκδόσεων τεκμηρίωσης, που εργάζονται σε συγχρονισμό με την ιστορία έλεγχο έκδοσης του κώδικα.
Σε περίπτωση που ο κωδικός σχολιάζει καταλαμβάνουν πολύ χώρο στην πηγή σας, μπορούν να εξαχθούν σε ένα ξεχωριστό αρχείο Markdown και στη συνέχεια δεμένα πίσω στο αρχικό κώδικα με τη χρήση απλών δεικτών.
Αυτό το τελευταίο χαρακτηριστικό λειτουργεί μεγάλο για τα μεγαλύτερα έργα, όπου περισσότερα από ένα άτομο εργάζεται για τον κώδικα και περισσότερο σε βάθος τα στοιχεία που απαιτούνται για κάθε λειτουργία, μέθοδος ή η παράμετρος.
.
DocumentJS & nbsp? Αναπτύχθηκε για να είναι μέρος του πλαισίου JavaScript - JavaScriptMVC
Χαρακτηριστικά :
- ευέλικτη οργάνωση της τεκμηρίωσης σας
- Ένα ολοκληρωμένο πρόγραμμα προβολής εγγράφων, όπου μπορείτε να αναζητήσετε API σας
- υποστήριξη Markdown
- Μία επεκτάσιμη αρχιτεκτονική
Τα σχόλια δεν βρέθηκε