Come utilizzare jsdoc nel mio script in esecuzione su node.js?

Question

Desidero utilizzare il modulo jsdoc per estrarre le voci della documentazione da un codice sorgente. Ho installato il modulo jsdoc e posso usare jsdoc nella riga di comando. Ma quando I require("jsdoc") nel mio codice, nodejs genera un errore che dice Cannot find module 'jsdoc'.

devo nodejs v0.8.25 e JSDoc 3.3.0-alpha2. È installato sia a livello locale che globale. posso usare jsdoc comando e ho jsdoc nella mia cartella node_modules. Non riesco a vedere dove si trova il problema.

Dove è possibile trovare della documentazione su jsdoc diversa da come utilizzarla nell'interfaccia della riga di comando o come documentare il codice sorgente di js. Vorrei una documentazione API.

Answer 1

Se si tratta di uno strumento automatico di documentazione, in generale, si potrebbe anche usare YUIDoc.

A seguito di questi tre passaggi, si avrà la documentazione automatica:

1. L'installazione: npm -g install yuidocjs
2. formattare i commenti relativi al YUIDoc Syntax Reference
3. Nella tua console corsa yuidoc . sulla parte superiore del vostro albero dei sorgenti JS

Answer 2

suona come non è stato installato correttamente jsdoc. Esegui npm install -g jsdoc dalla riga di comando. Se lo si esegue all'interno di una nuova finestra di terminale che si trova nella directory predefinita, non si dovrebbero avere problemi. Ho avuto problemi in cui ho provato a installare un modulo di nodo globalmente dalla mia attuale directory di lavoro e per qualsiasi ragione il modulo non si installa a livello globale.

Answer 3

stavo cercando di usare jsdoc come una libreria troppo, e mi sono imbattuto sullo stesso problema come avete fatto. Non hai fatto nulla di male, non è stato pensato solo per essere usato come libreria.

C'è an issue sulla pagina del progetto github del jsdoc relativa al presente. Hegemonic, il principale contributore di JSDoc detto:

JSDoc non è realmente progettato per essere utilizzato come libreria

Si potrebbe desiderare di esprimere il vostro desiderio di per la creazione di un'API per nodejs sulla questione collegato sopra.

Il require('jsdoc') non riesce perché non è presente il campo main dichiarato in jsdoc package.json. Potrebbe essere predefinito a 'index.js' o 'main.js', ma non esiste neanche un file di questo tipo.