JSDoc

JSDoc может производить документацию в широком ряде текстовых форматов, таких как HTML, XML, JSON, и так далее.
JSDoc ранее известный как JSDoc Toolkit.
Бывшие версии JSDoc используется Java для разбора исходного кода, извлечь комментарии и генерировать документацию. С 3.x отрасли Node.js используется вместо.
Кроме того, Node.js, JSDoc также может работать с Rhino двигателя Mozilla, а также.
Чтобы использовать JSDoc должным образом, проверьте документацию для получения информации о том, как форматировать исходный код комментарии, так что они могут быть обнаружены и использованы двигателя JSDoc в.

Что нового в этой версии:

• Теперь можно запустить JSDoc на Node.js.
• Теперь можно использоватьinterface иimplements теги к документу интерфейсы и их реализации.
• inheritDoc иOverride теги Closure Compiler в настоящее время поддерживаются.
• Если JSDoc комментарий для символа включает тегmixes, все Mixins теперь появляются в документации символа.
• JSDoc теперь могут регистрировать информацию на консоль, как она работает (например, имя каждого файла, который анализирует JSDoc). Для входа эту информацию, запустите JSDoc с --verbose флагом.
• Теперь можно использовать любой файл как пакет или README файл для Вашей документации. Используйте -p / - пакет / -R и / -. ReadME флаги, чтобы указать пакет и README файл
• типография и цветовая схема шаблон по умолчанию были значительно улучшены.

Что нового в версии 3.3.0:

• Теперь можно запустить JSDoc на Node.js.
• Теперь можно использоватьinterface иimplements теги к документу интерфейсы и их реализации.
• inheritDoc иOverride теги Closure Compiler в настоящее время поддерживаются.
• Если JSDoc комментарий для символа включает тегmixes, все Mixins теперь появляются в документации символа.
• JSDoc теперь могут регистрировать информацию на консоль, как она работает (например, имя каждого файла, который анализирует JSDoc). Для входа эту информацию, запустите JSDoc с --verbose флагом.
• Теперь можно использовать любой файл как пакет или README файл для Вашей документации. Используйте -p / - пакет / -R и / -. ReadME флаги, чтобы указать пакет и README файл
• типография и цветовая схема шаблон по умолчанию были значительно улучшены.

Что нового в версии 3.2.2 / 3.3.0-beta1:

• обратился к регрессии в JSDoc 3.2.1, которые могли бы предотвратить объявление функции от слежки заявление с тем же именем во внешней области видимости.
• Если ребенок класс переопределяет метод в родительском классе без оформления переопределенное метод, в документации метода уже скопирован из родительского класса.
• Теперь Вы можете использовать встроенные теги HTML в Markdown-форматированный текст. Кроме того, JSDoc теперь использует только заметное Markdown парсер; уценки-JS парсер был удален.
• Тип выражения теперь могут включать в себя гораздо более широкий спектр воспроизводимых видов. Кроме того, теперь вы можете использовать NULLABLE и ненулевых модификаторы Closure Compiler с повторяющимся типов. Например, выражение типа ...! Строка (повторяемые, необнуляемый строка) теперь корректно распознаны.

Требования:

• включен JavaScript на стороне клиента
• Node.js 0,10 или выше