ruby - 堆场文档和 `define_method`

Question

有没有办法在YardDoc 中注释用define_method 定义的方法？ ？

我试过这个:

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

但是，不幸的是，没有工作。

Answer 1

如果将方法创建移动到类方法中，则可以使用宏:

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

堆场输出:

- (String) one_way

The one way

Returns:

(String) — the one way

---

- (String) three_way

The three way

Returns:

(String) — the three way

---

- (String) two_way

The two way

Returns:

(String) — the two way