Wie verwende ich JSDoc unter Windows?

Question

Verzeihen Sie, wenn das eine dumme Frage ist, aber ich bin völlig verwirrt, wie ich JSDoc unter Windows verwenden kann. Ich kenne JSDoc-Toolkit, aber es ist ein bisschen veraltet und das Google-Code-Repository empfiehlt, stattdessen JSDoc 3 zu verwenden. Ich habe JSDoc von Github heruntergeladen und den jsdoc-master-Ordner auf meine lokale Festplatte entpackt, kann aber keine fundierten Informationen darüber finden, wie ich damit meine Dateien analysieren kann.

Answer 1

Sie können download it as an npm package für die Node.js JavaScript runtime environment.

1. installieren Node.js die mit npm
2. Öffnen Sie Ihre eine Befehlszeile

3. Installieren kommt auszuführen JsDoc durch Eingabe des folgenden Befehls

   npm install -g jsdoc

4. Führen Sie JsDoc/generate documentation aus. more info

   jsdoc path/to/file.js

5. Configure jsdoc (Optional)

Answer 2

Ok, also denke ich, ich finde es heraus. Ich sage nicht, dass dies notwendigerweise der richtige Weg ist, aber es hat für mich funktioniert. Hier geht:

1) Installieren node.js

2) Öffnen Sie eine Eingabeaufforderung

3) Als Test erstellen Sie einen Ordner in Ihrem Root-Laufwerk (c:\test) und gehen Sie zu ihm (cd\test). Ich vermute, es gab eine Art von Berechtigungsproblem, da ich die folgenden Schritte in meinem Desktopordner nicht ausführen konnte.

4) Installieren Sie das JSDoc Paket: npm -install jsdoc

5) Es gibt einen Ordner in testnode_modules genannt

6) Gehen Sie auf die .bin Unterordner in node_modules

7 sein sollte) sollte es eine Datei mit der Bezeichnung jsdoc.cmd. Einfache Verwendung jsdoc myfile.js in der Eingabeaufforderung JSDoc Skript auf Ihrer Datei