Простите меня, если это глупый вопрос, но я совершенно не понимаю, как я могу использовать JSDoc в Windows. Я знаю JSDoc-Toolkit, но он немного устарел, и репозиторий Google решает вместо этого использовать JSDoc 3. Я загрузил JSDoc из Github и распаковал папку jsdoc-master на свой локальный диск, но не могу найти твердую информацию о том, как ее использовать для анализа моих файлов.
Как использовать JSDoc для Windows?
Ответ 1
Вы можете загрузить его как пакет npm для среды Node.js JavaScript.
- Установите Node.js, который поставляется с npm
- Откройте командную строку
-
Установите JsDoc, введя следующую команду
npm install -g jsdoc -
Запустите документацию JsDoc/generate. подробнее
jsdoc path/to/file.js -
Настроить jsdoc (необязательно)
Ответ 2
Установка не очень хорошо документирована на странице проекта.
Это намного лучше объяснено на github-странице.
Ответ 3
Хорошо, поэтому я думаю, что я это понял. Я не говорю, что это обязательно говорит, что это правильный путь, но это сработало для меня. Здесь:
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 script в вашем файле