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

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

11
javascript jsdoc windows

2 ответов

Вы можете загрузите его как пакет npm на узел.JS и JavaScript в среде выполнения.

  1. установить узел.js которой входит НПМ
  2. Откройте командную строку

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

    npm install -g jsdoc

  4. выполнить JsDoc / генерировать документацию. больше info

    jsdoc path/to/file.js

  5. настройка jsdoc (необязательный)

16

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

1) установить узел.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 на вашем файле

-1