JSDoc FAQ – часто задаваемые вопросы по JSDoc

Вопрос: Как правильно писать названия JavaScript-типов, с большой или маленькой буквы? Например "number", "boolean", "string", "Array" или "Number", "Boolean", "Array"?

Ответ:

По сути это не важно. Как вариант можно писать названия примитивных типов с маленькой буквы. Также с маленькой буквы пишется тип function. А вот Array и Object пишутся с большой буквы.

Вот готовый список для использования:

boolean

number

string

Object

Array

Date

RegExp

Еще как вариант всё писать с маленькой буквы, точнее так как это возвращает оператор typeof.

---

Как установить JSDoc на Windows 10

Шаг 1

Скачать и установить node-v4.4.5-x64.msi.

Шаг 2

Чтобы установить JSDoc локально в текущую папку надо выполнить команду:
npm install jsdoc
Установка будет произведена в текущую папку по пути ./node_modules/.bin/jsdoc

Чтобы установить глобально надо выполнить команду:
npm install -g jsdoc
В таком случае jsdoc разместится по пути C:\Users\John\AppData\Roaming\npm\jsdoc.cmd

Шаг 3

Для генерации документации к файлу надо выполнить команду:
jsdoc script.js --destination ./doc/

Как мы документируем программные интерфейсы