モデルスコープのドキュメントをレールに追加する

Question

これが実際に可能かどうかはわかりませんが、私たちのapp/modelsファイルのスコープのドキュメントを追加することで、レールアプリケーションのドキュメントをより完成させようとしています。私は試してみてやって探していますは次のとおりです。

# 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が文書化されますより伝統的な方法と一緒に公共のクラスメソッドとしてリストされている見たい以下のような：

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

EDIT

私はこの質問は少し曖昧かもしれ実現します。ここでは明確にしようとしています：現在、scope宣言の上にコメント行を追加しようとすると、スコープのためにRDocによって生成されたドキュメントはありません。私はRDocがメタメソッド/属性を拾うことができることを知っています。それ以外の場合は、attr_accessorと宣言されたドキュメントに属性を表示しません。だから私の質問は、なるように、私は私のファイルにコメントを追加するにはどうすればよいです：それは公共のクラスメソッド（パブリックインスタンスメソッドなどではなく） として表示されますドキュメント

を生成する方法は、私のRDocに表示されます

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

Answer 2

スコープはクラスメソッドなので、Rdocは正しく処理しています。私はそれがRdocが知っている限り動作していると言います。

あなたはYARDのようにもっと拡張性のあるものを使ってコントロールする方がよいかもしれません。