Dokument doc i `define_method`

Question

Czy istnieje sposób komentowania metod zdefiniowanych w define_method w YardDoc?

Próbowałem to:

%w(one two three).each do |type| 
    # The #{type} way 
    # @return [String] the #{type} way 
    define_method("#{type}_way") do ... end 
end 

Ale, niestety, nie działa.

Answer 1

Jeśli przesuniesz stworzenie metody do metody klasy, można użyć makra:

class Foo 

    # @!macro [attach] generate 
    # @method $1_way 
    # The $1 way 
    # @return [String] the $1 way 
    def self.generate(type) 
    define_method("#{type}_way") do 
    end 
    end 

    generate :one 
    generate :two 
    generate :three 

end 

YARD wyjścia:

- (String) one_way 

Jedynym sposobem

Powroty:

(String) - ten sposób

---

- (String) three_way 

Trzy sposób

Powroty:

(String) - trzy way

---

- (String) two_way 

dwóch way

Powroty:

(String) - dwa way