Как я могу документировать неявные методы внутри моделей рельсов?

Question

Я использую YARD в своем проекте Rails, и мне было интересно, как бы я занялся документированием унаследованных / исполняемых методов в модели Rails? Например, документирование существования атрибута first_name в модели User.

Answer 1

Ты не можешь этого сделать, ИМХО.

Беда в том, что эти методы на самом деле не "существуют"; Они «создаются на лету» с помощью method_missing хуков, при первом их вызове, во время выполнения.

Другие системы генерации документации имеют способы объявления "неявных" методов. Например, NaturalDocs имеет ключевое слово function , которое позволяет создавать функции, которые существуют только в комментариях. Я недостаточно знаком с YARD, но, похоже, у него нет схожей функциональности.

Удачи!