ДВОР (программное обеспечение)
Оригинальный автор(ы) | Лорен Сигал |
---|---|
Первоначальный выпуск | 24 февраля 2007 г |
Стабильная версия | 0.9.5
/ 22 июня 2016 г [ 1 ] |
Репозиторий | |
Написано в | Руби |
Операционная система | Кросс-платформенный |
Тип | Встроенный генератор документации |
Лицензия | МОЯ лицензия |
Веб-сайт | Ярдок |
YARD — встроенный генератор документации для языка программирования Ruby . Он анализирует исходный код Ruby, создавая структурированную коллекцию страниц для объектов и методов Ruby. Комментарии к коду можно добавлять в естественном стиле.
YARD полезен, даже если целевой исходный код не содержит явных комментариев. YARD по-прежнему будет анализировать классы, модули и методы и перечислять их в сгенерированных файлах API.
YARD расширяет возможности RDoc в нескольких измерениях:
- расширяемость
- модульность
- анализ
Дэн Кубб создал вспомогательный инструмент под названием Yardstick, который проверяет покрытие документации YARD (или RDoc).
См. также
[ редактировать ]Ссылки
[ редактировать ]Внешние ссылки
[ редактировать ]- Домашняя страница проекта YARD
- Страница Лорен Сигал YARD на GitHub
- Страница Yardstick Дэна Кубба на GitHub