6

我正在写我的第一个 gem,我正在用 YARD 记录它。我已经让我的一个类有一个构造函数,它需要一个不带参数的块1

YARD 提供@yield [params] description标签来根据方法将传递给它的参数来描述块参数,但如果params列表为空,则格式不正确。我应该如何记录没有参数的块?

1:从技术上讲,我什yield至不知道;我的代码如下所示:

def initialize(&block)
  define_singleton_method(:create, block)
  create
  class << self; undef_method :create; end
end

...因此该块包含要在新创建的对象的上下文中运行的代码。如果出于某种原因这是一个糟糕的主意,我也很高兴知道这一点:)

4

1 回答 1

3

我在 YARD 的 github 页面上发现了一个老问题;看起来参数块应该被省略:

# @yield Description of the block here
def initialize(&block)
  define_singleton_method(:create, block)
  create
  class << self; undef_method :create; end
end
于 2013-04-22T11:35:03.570 回答