Аргументы командной строки для JSDoc
Содержание
В самом простом случае JSDoc используется так:
/path/to/jsdoc yourSourceCodeFile.js anotherSourceCodeFile.js ...
где ... — пути к другим файлам, для которых требуется сгенерировать документацию.
Кроме того, можно указать путь к файлу Markdown (Markdown file, заканчивающемуся на ".md") или файлу с именем "README", и он будет добавлен в документацию на главной странице. См. эти инструкции.
JSDoc поддерживает множество опций командной строки, многие из которых имеют длинную и короткую форму. В качестве альтернативы, опции командной строки можно указать в файле конфигурации, передаваемом JSDoc. Опции командной строки:
| Опция | Описание |
|---|---|
-a <value>, --access <value>
|
Отображать только символы с заданным access свойством: private, protected, public, или undefined, или all для всех уровней доступа. По умолчанию отображаются все, кроме private символов. |
-c <value>, --configure <value>
|
Путь к файлу конфигурации JSDoc файла конфигурации. По умолчанию conf.json или conf.json.EXAMPLE в каталоге, где установлен JSDoc. |
-d <value>, --destination <value>
|
Путь к папке вывода сгенерированной документации. Для встроенного шаблона Haruki JSDoc используйте console для вывода данных в консоль. По умолчанию ./out. |
--debug |
Выводить информацию, которая может помочь в отладке проблем с самим JSDoc. |
-e <value>, --encoding <value>
|
Предполагать эту кодировку при чтении всех исходных файлов. По умолчанию utf8. |
-h, --help
|
Отобразить информацию об опциях командной строки JSDoc, а затем выйти. |
--match <value> |
Выполнять только тесты, имена которых содержат value. |
--nocolor |
При запуске тестов не использовать цвет в выводе консоли. В Windows эта опция включена по умолчанию. |
-p, --private
|
Включить в сгенерированную документацию символы, помеченные тегом @private тег. По умолчанию символы с пометкой private не включаются. |
-P, --package
|
Файл package.json, содержащий имя проекта, версию и другую информацию. По умолчанию используется первый package.json файл, найденный в путях исходных файлов. |
--pedantic |
Обрабатывать ошибки как фатальные, а предупреждения как ошибки. По умолчанию false. |
-q <value>, --query <value>
|
Строка запроса для парсинга и хранения в глобальной переменной env.opts.query. Пример: foo=bar&baz=true. |
-r, --recurse
|
Рекурсивно проходить по подкаталогам при сканировании исходных файлов и учебных материалов. |
-R, --readme
|
Файл README.md для включения в сгенерированную документацию. По умолчанию используется первый README.md файл, найденный в путях исходных файлов. |
-t <value>, --template <value>
|
Путь к шаблону, используемому для генерации вывода. По умолчанию templates/default, встроенный шаблон JSDoc. |
-T, --test
|
Запустить тестовый набор JSDoc и вывести результаты в консоль. |
-u <value>, --tutorials <value>
|
Каталог, в котором JSDoc должен искать учебные материалы. Если опущено, страницы учебных материалов не будут сгенерированы. Подробнее см. инструкции по учебным материалам. |
-v, --version
|
Отображает номер версии JSDoc, а затем выходит. |
--verbose |
Выводить подробную информацию в консоль во время работы JSDoc. По умолчанию false. |
-X, --explain
|
Вывести все doclets в консоль в формате JSON, а затем выйти. |
Примеры
Сгенерировать документацию для файлов в каталоге ./src, используя файл конфигурации /path/to/my/conf.json, и сохранить вывод в каталоге ./docs.
/path/to/jsdoc src -r -c /path/to/my/conf.json -d docs
Запустить все тесты JSDoc, имена которых содержат слово tag, и вывести информацию о каждом тесте:
/path/to/jsdoc -T --match tag --verbose
Связанные ссылки
Настройка JSDoc с помощью файла конфигурации
© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://jsdoc.app/about-commandline.html
