YARDを使用してメタプログラミングで作成されたドキュメント化メソッド

Question

現在、私は宝石を手作りしており、ドキュメントを作成しています。私は現在、いくつかの方法は次のようdefined_methodを使用して定義しているクラスがあります。

class Client 
    ['one', 'two'].each do |method_name| 
    # Sets the value 
    # @param argument the argument to set. 
    define_method("set_#{method_name}") do |argument| 
     # Method content 
    end 
    end 
end 

私はYARDを使用して、これらの方法を文書化しようとしているが、プロジェクトのドキュメントを生成するとき、メソッドがクラスに表示されません学位論文よドキュメンテーション。

これをどのように文書化することができますか？何か不足していますか？

Answer 1

代わりに任意のリストを繰り返し処理の、あなたは一般的に、あなたのクラスのDSLスタイルの呼び出しとして文書化することができ、クラスメソッドに動的挙動をラップすることにより、メソッドを定義するためのマクロを使用します。

class << self 
    private 
    # @macro [attach] container.increment 
    # @method $1() 
    # Increment the $1 container. 
    def make(name) 
     define_method(name) { container.send(name).increment } 
    end 
    end 

    make :lion 
    make :pigeon 
end 

・ホープそれはあなたのために働く。