JSDoc

JSDoc може да произвежда документация в широк брой текстови формати като HTML, XML, JSON, и така нататък.

JSDoc е предварително знаем като JsDoc Toolkit.

бивши версии JSDoc използват Java да прави разбор на изходния код, екстракт коментари и генериране на документацията. От бранша 3.x Node.js се използва вместо.

Освен Node.js, JSDoc също може да работи с двигател на Mozilla Rhino, както добре.

За да използвате JSDoc правилно, проверете своята документация за информация за това как да форматирате вашите изходния код коментари, така че те могат да бъдат открити и използвани от двигателя JSDoc му.

Какво ново в тази версия:.

• сега може да тече JSDoc на Node.js
• вече могат да използватinterface иimplements таговете да се документира интерфейси и техните реализации.
• inheritDoc иoverride тагове Закриване Compiler е вече се поддържат.
• Ако коментара JSDoc за символ включва тагmixes, всички mixins сега се появяват в документацията със символа му.
• JSDoc сега мога да вляза информация на конзолата, тъй като работи (например, името на всеки файл, който JSDoc прави разбор). За да влезете тази информация, бягай JSDoc с --verbose знаме.
• вече могат да използват всеки файл, като опаковката или README файл за вашата документация. Използвайте -p / най - пакет / и -R / -. README знамената да уточни пакета и README файл
• типография и цветова схема на шаблона по подразбиране са значително подобрени.

Какво ново във версия 3.3.2:

• сега може да тече JSDoc на Node.js.
• вече могат да използватinterface иimplements таговете да се документира интерфейси и техните реализации.
• inheritDoc иoverride тагове Закриване Compiler е вече се поддържат.
• Ако коментара JSDoc за символ включва тагmixes, всички mixins сега се появяват в документацията със символа му.
• JSDoc сега мога да вляза информация на конзолата, тъй като работи (например, името на всеки файл, който JSDoc прави разбор). За да влезете тази информация, бягай JSDoc с --verbose знаме.
• вече могат да използват всеки файл, като опаковката или README файл за вашата документация. Използвайте -p / най - пакет / и -R / -. README знамената да уточни пакета и README файл
• типография и цветова схема на шаблона по подразбиране са значително подобрени.

Какво ново във версия 3.3.0:

• сега може да тече JSDoc на Node.js.
• вече могат да използватinterface иimplements таговете да се документира интерфейси и техните реализации.
• inheritDoc иoverride тагове Закриване Compiler е вече се поддържат.
• Ако коментара JSDoc за символ включва тагmixes, всички mixins сега се появяват в документацията със символа му.
• JSDoc сега мога да вляза информация на конзолата, тъй като работи (например, името на всеки файл, който JSDoc прави разбор). За да влезете тази информация, бягай JSDoc с --verbose знаме.
• вече могат да използват всеки файл, като опаковката или README файл за вашата документация. Използвайте -p / най - пакет / и -R / -. README знамената да уточни пакета и README файл
• типография и цветова схема на шаблона по подразбиране са значително подобрени.

Какво ново във версия 3.2.2 / 3.3.0-бета1:

• Адресирана регресията в JSDoc 3.2.1, която може да попречи на функцията декларация от сенки декларация със същото име във външния обхват.
• Ако едно дете клас надделява метод в един клас, майка, без документиране подтиснатия метода, документацията на метода сега е копиран от родителския клас.
• Вече можете да използвате вградените HTML тагове в Markdown-форматиран текст. В допълнение, JSDoc сега използва само маркираната Markdown анализатор; на евтино-JS парсера е била отстранена.
• Тип изрази вече могат да включват много по-широк кръг от повторяеми видове. Освен това, сега можете да използвате nullable и не-nullable модификатори Закриване Compiler с повторяеми видове. Например, низът тип изразяване ...! (Повторяем, не-nullable низ) сега се прави разбор правилно.

Какво ново във версия 2.4.0:

• Фиксирана бъг, който добавя mutiple символи със същото име до документи.
• Добавена е поддръжка за -m опцията за подтискане на предупрежденията за множество документи.
• Добавена пластир от brownsea42 да подкрепят цитирани потребителски променливи в командния ред.
• Фиксирана бъг, който понякога причинени линкове към събития, за да бъде неточна.

<> силни Изисквания

• JavaScript поддръжка на клиентска страна
• Node.js 0.10 или по-високи