ruby-on-rails - 在 Rails 中添加模型范围的文档

Question

我不确定这是否真的可行，但我试图通过在我们的 app/models 中添加范围文档来使我们的 rails 应用程序的文档更加完整。文件。我正在尝试做的是:

# This is a description of what the scope does and the action that it performs
scope :newest_records, order("created_at desc").limit(50)

然后当我在应用程序上运行 rdoc 时，我 想要看newest_records与更传统的方法一起列为公共(public)类方法，这些方法将被记录如下:

# some more documentation about this method
def self.a_class method
  ....
end

编辑

我意识到这个问题可能有点模棱两可。所以这里尝试澄清一下:目前，当我尝试在 scope 上方添加注释行时声明我没有得到 RDoc 为范围生成的文档。我知道 RDoc 可以获取元方法/属性，否则它不会在用 attr_accessor 声明的文档中显示属性.所以我的问题是如何向我的文件添加评论，以便:

该方法出现在我的 RDoc 生成的文档中

它显示为公共(public)类方法(与公共(public)实例方法等相反)

Answer 1

在 RDoc Docs 中进行了一些挖掘之后，我想我已经设法回答了我自己的问题。

您可以按如下方式记录范围:

##
# :singleton-method:
# Documentation for the scope to explain what it does
scope :newest_records, order("created_at desc").limit(50)

双散列用于获取元编程方法，如果您正在创建实例方法，那么这就是您所需要的。但是，作为作用域创建一个类方法，您还需要使用 :singleton-method: 行来表明这一点。文档在以下几行中继续正常进行。

您可以在 RDoc Documentation 中查看记录元方法等的完整语法。