Railsモデル内に暗黙のメソッドを文書化するにはどうすればよいですか？

Question

私は使用しています ヤード 私のRailsプロジェクトで、Railsモデルの継承/ランタイムメソッドを文書化する方法を疑問に思っていましたか？たとえば、aの存在を文書化します first_name aの属性 User モデル。

Answer 1

あなたはそれをすることはできません、私見。

問題は、これらの方法が実際には「存在する」ことはないということです。それらは「その場で作成された」 method_missing ランタイム時に初めて呼び出されるフック。

他のドキュメンテーション生成システムには、「暗黙の」メソッドを宣言する方法があります。たとえば、NaturalDocsにはaがあります 関数キーワード これにより、コメントにのみ存在する関数を作成できます。私は庭に十分に精通していませんが、同様の機能はないようです。

幸運を！