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.2:

• Тепер можна запустити 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 в уцінки-форматований текст. Крім того, в даний час використовує JSDoc тільки помітне Markdown парсер; уцінки-JS парсер був видалений.
• Тип вирази можуть в даний час включають широкий спектр повторюваних типів. Крім того, тепер ви можете використовувати Nullable і ненульових модифікатори Closure Compiler з повторюваних типів. Наприклад, вираз типу ...! Рядок (повторюю, не обнуляє рядок) тепер коректно розпізнані.

Що нового у версії 2.4.0:

• Виправлена ​​помилка, додав Mutiple символів з тим же ім'ям в документації.
• Додана підтримка для опції -m, щоб придушити попередження для декількох документації.
• Додана патч від brownsea42 підтримувати цитує користувача змінні в командному рядку.
• Виправлена ​​помилка, яка іноді призводила до подій посилання, щоб бути невірним.

Вимоги

• включений JavaScript на стороні клієнта
• Node.js 0,10 або вище