私は自分の Rails プロジェクトでYARDを使用していますが、Rails モデルで継承されたメソッドやランタイム メソッドをどのように文書化するのだろうかと考えていました。たとえば、モデルのfirst_name
属性の存在を文書化します。User
質問する
359 次
1 に答える
0
あなたはそれをすることはできません、IMHO。
問題は、これらのメソッドが実際には「存在しない」ことです。method_missing
それらは、実行時に最初に呼び出されたときに、フックを介して「オンザフライで作成」されます。
他のドキュメント生成システムには、「暗黙の」メソッドを宣言する方法があります。たとえば、NaturalDocs には、コメントにのみ存在する関数を作成できるfunction キーワードがあります。私は YARD に詳しくありませんが、同様の機能はないようです。
幸運を!
于 2010-05-19T07:43:50.567 に答える