如何记录 rails 模型中的隐式方法？

【问题标题】：How can I document implicit methods inside of rails models?如何记录 rails 模型中的隐式方法？
【发布时间】：2010-05-18 18:10:06
【问题描述】：

我在我的 Rails 项目中使用YARD，想知道如何在 Rails 模型上记录继承/运行时方法？例如，记录 User 模型上存在 first_name 属性。

【问题讨论】：

gilesbowkett.blogspot.com/2008/02/… Ruby2Ruby 可能会有所帮助，但您必须自己构建 rdoc 生成工作流程，gem rdoc your_project 很可能无法正常工作，除非您对 rdoc 进行了一些疯狂的分叉。跨度>

【解决方案1】：

你不能那样做，恕我直言。

问题在于这些方法并不真正“存在”；它们是通过 method_missing 钩子“动态创建”的，在运行时第一次调用它们。

其他文档生成系统有声明“隐式”方法的方法。例如 NaturalDocs 有一个function keyword，它允许您创建仅存在于 cmets 上的函数。我对 YARD 不够熟悉，但它似乎没有类似的功能。

祝你好运！

【讨论】：