Yard doc e `define_method`

Question

Esiste un modo per commentare i metodi definiti con define_method in YardDoc?

ho provato questo:

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

Ma, purtroppo, non funziona.

Answer 1

Se si sposta la creazione di una funzione all'interno di un metodo di classe, è possibile utilizzare una macro:

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 uscita:

- (String) one_way 

L'unico modo

Returns:

(String) - l'unico modo

---

- (String) three_way 

Il tre vie

Returns:

(String) - le tre vie

---

- (String) two_way 

.210

le due vie

Returns:

(String) - le due vie