文檔塊不帶參數

Question

我正在寫我用YARD記錄的第一顆寶石。 我已經讓我的一個類有一個構造函數，它需要一個不帶參數¹的塊。

YARD提供了@yield [params] description標記，用於根據方法傳遞給它的參數來描述塊參數，但如果params列表為空，則不能正確格式化。 我該如何記錄沒有參數的塊？

¹ ：從技術上講，我甚至沒有yield這個障礙; 我的代碼看起來像這樣：

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

...所以該塊包含要在新創建的對象的上下文中運行的代碼。 如果由於某種原因這是一個可怕的想法，我也很高興知道，:)

Answer 1

我在YARD的github頁面上發現了一個老問題 ; 看起來應該省略參數塊：

# @yield Description of the block here
def initialize(&block)
  define_singleton_method(:create, block)
  create
  class << self; undef_method :create; end
end