YUIDoc є офіційним Генератор документації використовується командою Yahoo! для Yahoo! Користувальницький інтерфейс 3.x (YUI) серії.
Додаток працює шляхом сканування JavaScript код для коментарів, і використовувати їх як документації для самого коду.
YUIDoc може бути використаний для документування інформації про властивості, призначені для користувача події, методи та успадкування для об'єктів JS.
Окрім створення сайтів документації з коду JavaScript, YUIDoc також поставляється з вбудованим веб-сервер, а також. Ця функція була включена, щоб дозволити розробникам переглядати сайти документації в режимі реального часу, в той час як вони пишуть свій код і коментарі.
YUIDoc не слід плутати з YUI & NBSP; Doc , аналогічним генератора документації від Yahoo, але написаний в основному на Python
Що нового. У цьому випуску :.
- YUIDoc v0.9.0 підтримує документування користувача елементів
Що нового у версії 0.7.0:
- Виправлено:
- Переключити на вірних варіантів Markdown за замовчуванням
- Виправлена помилка, успадкований клас був розібраний в два рази
- Unindent метод Рулі часткові межах класів конструктора
- Використання logFn конфігурацію входу
- Змінено:
- Падіння видалені правила JSHint
Що нового у версії 0.6.0:
- Змінено:
- The уцінки парсер уцінки-IT
- Додати Node.js v0.12 і io.js в Тревіс CI установка
- Виправлено:
- Виправлена помилка з & Quot; @ & Quot; НЕ escapable в прикладі
Що нового у версії 0.5.0:
- YUIDoc поддержіваетthrows тег нарешті, і включає в себе більше сумісності з Рулі v2.0, удосконалень і залежностей оновлення.
Що нового у версії 0.4.0:
- Підтримка ES6 стиль інші параметри синтаксис декількох параметрів
- Дозволяє базові адреси для зовнішніх посилань
- Додає --no сортування варіант
Що нового у версії 0.3.49 :.
- Змінено створення URL просто приєднатися рядків
Що нового у версії 0.3.47:
- Зміна пилоутворення: Успішне небудь смачненьке виходить з командного рядка, невдало небудь смачненьке виходить з процесу.
- Змінити що-небудь смачненьке, щоб процес завершується тільки в разі невдачі.
Вимоги
- Node.js 0,4 або вище
Коментар не знайдено