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

Question

я использую ПЛОЩАДКА На моих рельсах проекта и было интересно, как я пойду о документировании методов унаследованного / выполнения в модели рельсов? Например, документирование существования first_name атрибут на A. User модель.

Answer 1

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

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

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

Удачи!