JSDoc - это язык разметки, используемый для аннотирования исходного кода JavaScript с использованием комментариев. Аннотации обрабатывается различными инструментами для создания документации в доступных форматах, таких как HTML и Rich Text Format.
Начало работы
Создание проекта
Для создания проекта выполните следующие команды:
-
mkdir learn-jsdoc && cd learn-jsdoc- создание каталога проекта. -
npm init -y- инициализация проекта. -
touch index.js- создание файлаindex.js
Установка JSDoc
Выполните установку JSDoc одним из следующих способов:
-
Глобально:
sudo npm install -g jsdoc