ruby - 如何为使用 class_eval 定义的方法添加 RDoc 文档？

Question

我正在使用 class_eval 来更简洁地定义一堆重复的方法，像这样:

%w{greasy chunky bacon}.product(%w{flying sky poodle}).each do |a,b|
  class_eval "def #{a}_#{b}; do_something; end"
end

我希望所有生成的方法都包含在 RDoc 文档中。是否有 RDoc 指令“手动”将方法添加到类的方法列表中？我找不到。

Answer 1

请参阅 RDoc documentation for RDoc::Parser::Ruby 中有关元编程方法 和隐藏方法和属性 的部分.

在你的情况下，你会做类似的事情:

##
# :method: greasy_flying
# Makes grease fly.

##
# :method: chunky_poodle
# This is a really gruesome method. Ewww!

等等。