Описание тега yard
YARD означает "Ура! Инструмент документации Ruby". Он считается альтернативой инструменту rdoc с большим количеством функций.
YARD означает "Ура! Инструмент документации Ruby". Он считается альтернативой инструменту rdoc с большим количеством функций. На сайте ДВОР написано:
YARD - это инструмент создания документации для языка программирования Ruby. Он позволяет пользователю создавать согласованную, удобную документацию, которую можно очень легко экспортировать в ряд форматов, а также поддерживает расширение для пользовательских конструкций Ruby, таких как определения пользовательского уровня класса.
Примечательные особенности YARD:
- Предварительный просмотр при документировании
- Легко настраивайте шаблоны
- Поддержите свой собственный DSL
- Расширять, расширять, расширять!
И, конечно же, YARD обладает гораздо большей функциональностью, включая возможность обслуживания документации для драгоценных камней, возможность группировать методы в логические разделы и многое другое.