DocumentJS funziona tramite la riga di comando Node.js e consente agli sviluppatori di creare siti di documentazione, senza dover fare un doppio lavoro di routine di scrivere commenti nel loro codice e poi spiegare in un secondo momento in un file HTML separato.
Il sito di documentazione viene creata usando il codice sorgente si commenta, il tutto automaticamente se gli sviluppatori seguono commenti del codice semplici regole di formattazione.
DocumentJS supporta strutture semplici e la sintassi Markdown, insieme con la capacità di creare la documentazione di versione, che lavora in sincronia con la storia controllo di versione del codice.
Nel caso in cui il codice commenti occupare troppo spazio nella vostra fonte, possono essere esportati in un file Markdown separato e poi di nuovo legati al codice originale utilizzando marcatori semplici.
Quest'ultima caratteristica funziona alla grande per i progetti di grandi dimensioni in cui più di una persona lavora sul codice e maggiori dettagli approfonditi sono necessari per ogni funzione, metodo o parametro.
.
DocumentJS & nbsp; è stato sviluppato per essere parte del framework JavaScript - JavaScriptMVC
Funzioni :
- organizzazione flessibile della documentazione
- Un visualizzatore di documenti integrato in cui è possibile cercare il API
- Supporto Markdown
- Un'architettura estensibile
I commenti non trovato