Как использовать JSDoc для Windows?

Question

Простите меня, если это глупый вопрос, но я совершенно не понимаю, как я могу использовать JSDoc в Windows. Я знаю JSDoc-Toolkit, но он немного устарел, и репозиторий Google решает вместо этого использовать JSDoc 3. Я загрузил JSDoc из Github и распаковал папку jsdoc-master на свой локальный диск, но не могу найти твердую информацию о том, как ее использовать для анализа моих файлов.

Answer 1

Вы можете download it as an npm package для Node.js JavaScript runtime environment.

1. Установите Node.js, который поставляется с npm
2. Откройте вашу командной строку

3. Установить JsDoc, введя следующую команду:

   npm install -g jsdoc

4. Запустить JsDoc/создать документацию. more info

   jsdoc path/to/file.js

5. Configure jsdoc (опционально)

Answer 2

Хорошо, поэтому я думаю, что я это выясняю. Я не говорю, что это обязательно говорит, что это правильный путь, но это сработало для меня. Здесь идет:

1) Установите node.js

2) Откройте командную строку

3) В качестве теста, создать папку в корневом диске (c:\test) и идти к ней (cd\test). Я предполагаю, что была какая-то проблема с разрешением, поскольку я не мог выполнить следующие шаги для работы в моей папке рабочего стола.

4) Установите пакет JSDoc: npm -install jsdoc

5) Там должна быть папка в test называется node_modules

6) Перейти к .bin вложенной в node_modules

7) Там должно быть файл под названием jsdoc.cmd. Простое использование jsdoc myfile.js в командной строке выполнить сценарий JSDoc на файл