不带参数的文档块

Cho*_*ett 6 ruby block yard

我正在编写我的第一个 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
Run Code Online (Sandbox Code Playgroud)

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

Cho*_*ett 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
Run Code Online (Sandbox Code Playgroud)