無參數文檔塊

我正在寫我的第一個gem，我正在用YARD進行記錄。我已經讓我的一個類有一個構造函數，它需要一個不帶參數的塊。無參數文檔塊

YARD提供@yield [params] description標記來描述一個方法將傳遞給它的參數的塊參數，但如果params列表爲空，它將無法正確格式化。我應該如何記錄一個沒有參數的塊？

：從技術上說，我甚至沒有yield ing塊;我有一些代碼，看起來像這樣：

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

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

來源

2013-04-22 Chowlett

感謝@sawa的編輯，但問題主要是關於YARD文檔，而不是塊使用模式。 – Chowlett 2013-04-22 11:07:20

我在YARD的github頁面找到了old issue;它看起來應該只是省略參數塊：

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

來源

2013-04-22 11:35:03 Chowlett

無參數文檔塊

回答

相關問題