Настройка JSDoc?

Question

Я не так хорош в компьютерах, но я пытаюсь использовать JSDoc для одного из моих проектов,

Учебник, чтобы получить его и работает здесь

http://usejsdoc.org/about-jsdoc3.html

Я скачал программу из github, но теперь не понимаю, что я должен делать. У меня есть куча файлов в папке и я не знаю, как это сделать для моего проекта.

Может кто-то пожалуйста, дайте мне шаг за шагом инструкции о том, как на самом деле получить JSDoc работу, как настроить его, как я использую его и т.д.

Я знаю, что это может быть обыденным для некоторых из вас , но эй, мы все должны начать где-то правильно?

Answer 1

Ну, вы используете Windows или GNU/Linux? Во-первых, вы должны следить за тегами по умолчанию, чтобы разметка вашего исходного кода, определение ваших классов, методов, параметров и т. Д. После этого вы загружаете файл здесь: https://github.com/jsdoc3/jsdoc Извлеките его, а затем перейдите в папку jsdoc-master ,

Внутри него у вас есть сценарий jsdoc (без расширения). Только вам нужно выполнить его, указав на весь путь к вашему .js-файлу, который вы хотите создать такую ​​документацию: ./jsdoc your_class.js Затем через пару минут вы получите выход внутри 'out' папка. Откройте файл .html и взломайте! У вас хорошая документация.

Прямо здесь вы можете найти некоторые общие теги для использования в коде (как комментарии): http://usejsdoc.org/

Это решение для системы на базе Unix. Но есть еще один, использующий nodejs (который вы можете запускать с окнами, Linux, Mac и т. Д.). Во-первых, скачать nodejs здесь: http://nodejs.org/

Затем перейдите на этот сайт, чтобы посмотреть на пакет JSDoc: https://npmjs.org/

Затем вернитесь к терминалу (в любой операционной системе после установленной узел) и введите: npm install -g jsdoc Опция -g означает глобально, поэтому у вас есть внутренняя папка ваших пакетов узлов, и они доступны для любого проекта, который у вас есть, и вам не нужно устанавливать его снова и снова ...

Наконец, вы можете просто использовать эту команду: путь jsdoc/to/your/file.js

И все! Надеюсь, это поможет вам.

Answer 2

После того, как вы извлекли файл, загруженный прочь GitHub, перейдите в папку и запустить в терминале:

./jsdoc 

с параметрами, которые вы хотите.

Если вы хотите, чтобы отобразить меню помощи

./jsdoc --help 

Если вы хотите установить программу на вашей системе, при условии, макинтош или Линукс машину, используя корень пользователя или sudo:

npm install --save -g [~/Downloads/jsdoc-3.2.2 or your path to the downloaded extracted files]