Wie benutze ich jsdoc in meinem Skript, das auf node.js läuft?

Question

Ich möchte jsdoc Modul verwenden, um Dokumentationseinträge aus einem Quellcode zu extrahieren. Ich habe jsdoc Modul installiert und ich kann jsdoc in der Befehlszeile verwenden. Aber wenn ich require("jsdoc") in meinem Code, Nodejs wirft einen Fehler, Cannot find module 'jsdoc'.

Ich habe nodejs v0.8.25 und JSDoc 3.3.0-alpha2. Es wird sowohl lokal als auch global installiert. Ich kann Befehl verwenden und ich habe jsdoc in meinem node_modules Ordner. Ich kann nicht sehen, wo das Problem liegt.

Wo finde ich einige Dokumentationen über jsdoc, außer wie man es in der Kommandozeilenschnittstelle benutzt oder wie man js Quellcode dokumentiert. Ich hätte gerne eine API-Dokumentation.

Answer 1

Wenn es sich generell um ein automatisches Dokumentationswerkzeug handelt, können Sie auch YUIDoc verwenden.

diese drei Schritten werden Sie Ihre automatische Dokumentation haben:

1. es installieren: npm -g install yuidocjs
2. Format Ihre Kommentare in Bezug auf die YUIDoc Syntax Reference
3. In der Konsole laufen yuidoc . auf Ihre JS-Source-Tree

Answer 2

Es klingt, als ob Sie jsdoc nicht korrekt installiert haben. Führen Sie npm install -g jsdoc von Ihrer Befehlszeile aus. Wenn Sie dies in einem neuen Terminalfenster ausführen, das sich im Standardverzeichnis befindet, sollten Sie keine Probleme haben. Ich hatte Probleme, wo ich versucht habe, ein Knotenmodul global aus meinem aktuellen Arbeitsverzeichnis zu installieren und aus welchem ​​Grund auch immer das Modul nicht global installiert wird.

Answer 3

Ich wollte auch jsdoc als eine Bibliothek verwenden, und ich stolperte über das gleiche Problem wie Sie. Sie haben nichts falsch gemacht, es war nie als Bibliothek gedacht.

Es gibt an issue auf der Github-Projektseite von jsdoc, die sich darauf bezieht. Hegemonic, die Hauptursache von JSDoc sagte:

JSDoc nicht wirklich als Bibliothek verwendet zu werden ist

Vielleicht möchten Sie Ihren Wunsch für die Schaffung einer API für NodeJS zu diesem Thema äußern oben verlinkt.

Die require('jsdoc') schlägt fehl, weil kein main Feld in der JSDOC package.json deklariert ist. Es könnte standardmäßig "index.js" oder "main.js" sein, aber es gibt auch keine solche Datei.