Я использую YARD в проекте Rails и задавался вопросом, как я буду документировать методы унаследованных/runtime в Rails-модели? Например, документирование существования атрибута first_name на модели User.Как я могу документировать неявные методы внутри моделей рельсов?
Вы не можете этого сделать, ИМХО.
Беда в том, что эти методы действительно не существуют; Они создаются «на лету» через method_missing крючки при первом запуске во время выполнения.
Другие системы генерации документации имеют способы объявить «неявные» методы. Например, NaturalDocs имеет function keyword, который позволяет создавать функции, которые существуют только в комментариях. Я не достаточно хорошо знаком с YARD, но, похоже, у него нет аналогичной функциональности.
Удачи вам!
http://gilesbowkett.blogspot.com/2008/02/activerecord-ruby2ruby-this-is-where.html Ruby2Ruby может оказаться полезным, но вам нужно будет создать свой собственный рабочий процесс rdoc, 'gem rdoc ваш_проект, скорее всего, не сработает, если вы не совершили какую-то безумную вилку rdoc. –