Generazione documentazione Javascript

Question

Sto cercando di documentare il codice javascript che sviluppiamo e stiamo cercando alcuni buoni generatori di documentazione javascript, qualcuno ha qualche suggerimento?

Abbiamo usato ndoc per creare documentazione per il nostro codice C# e stiamo cercando qualcosa di simile per documentare il nostro codice js - idealmente qualcosa che può essere eseguito da una riga di comando.

grazie in anticipo!

Answer 1

È possibile utilizzare il famoso JSDoc-Toolkit per quello.

JsDoc Toolkit è un'applicazione, scritta in JavaScript, per la generazione automatica di template in formato multi-pagina HTML (o XML, JSON, o qualsiasi altro testo-based) documentazione commentato codice sorgente JavaScript .

E sì, ha anche command line options.

Answer 2

JSDoc è un approccio alla generazione di documentazione da JavaScript commentato. Ci sono molte varianti:

• Inizialmente implementato in Perl.
• JSDoc-Toolkit portandolo su JavaScript, ma richiede Java poiché utilizza il motore JavaScript di Rhino scritto in Java.
• Diverse persone hanno eseguito il porting per eseguire direttamente il motore/piattaforma JavaScript node.js, ad es. node-jsdoc-toolkit.
• dox eseguito anche su node.js, combina tag JSDoc-like e markdown markdown ma richiede un motore di template separato (come usato su Stack Overflow e github).

Tutti eseguiti dalla riga di comando. Scegli in base alle tue preferenze di utensili. Mi piace node.js per la sua velocità e la sensazione all-JavaScript-tutto-tempo. Il DailyJS "Facciamo un quadro" post on writing documentation descrive questi e altri strumenti; sfortunatamente dox è stato radicalmente revisionato per produrre solo strutture JSON da quando è stato scritto.

https://stackoverflow.com/q/1221413/1162195 menziona altri generatori di documentazione JavaScript.