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, wirft Nodejs einen Fehler mit der Angabe 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 den jsdoc -Befehl verwenden und ich habe jsdoc in meinem node_modules -Ordner.
Ich kann nicht sehen, wo das Problem ist.
Wo finde ich eine Dokumentation über jsdoc , außer über die Verwendung in der Befehlszeilenschnittstelle oder über die Dokumentation von js-Quellcode. Ich hätte gerne eine API-Dokumentation.
Ich wollte auch jsdoc als eine Bibliothek verwenden, und ich stolperte über das gleiche Problem wie Sie. Du hast nichts falsch gemacht, es war einfach nie dazu gedacht, als eine Bibliothek benutzt zu werden.
Es gibt ein Problem auf den Jsdocs Github-Projektseite dazu. Hegemonic , der Hauptvertreter von JSDoc sagte:
JSDoc ist nicht wirklich als Bibliothek gedacht
Sie möchten vielleicht Ihren Wunsch zum Erstellen einer API für nodejs zu dem oben verlinkten Problem ausdrücken.
Das require('jsdoc') schlägt fehl, weil kein main -Feld in der package.json von jsdoc deklariert ist. Es könnte standardmäßig 'index.js' oder 'main.js' sein, aber es gibt auch keine solche Datei.
Es hört sich so an, als hätten Sie jsdoc nicht korrekt installiert. 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.
Wenn es sich generell um ein automatisches Dokumentationswerkzeug handelt, können Sie auch YUIDoc verwenden.
Nach diesen drei Schritten haben Sie Ihre automatische Dokumentation:
npm -g install yuidocjs yuidoc . über Ihrer JS-Quellstruktur Tags und Links javascript node.js require jsdoc