2012-07-03 59 views
5

我試圖用yard記錄一些Ruby代碼和即使我做什麼描述herehere警告在院子裏與@param標籤

# @param [Integer] the number of trials (>= 0) 
# @param [Float] success probability in each trial 
def initialize(n, p) 
    # initialize... 
end 

我仍然得到這個奇怪的錯誤,雖然

@param tag has unknown parameter name: the 
@param tag has unknown parameter name: success 

然後生成的html看起來很奇怪。我打電話yard這樣的:

$ yard doc -m markdown 

什麼可能我是做錯了什麼?

回答

8

醫生說@param標籤具有格式

@param [Type] name description 

和你的線不包括(分別爲n和p)參數名稱

+2

非常感謝!我沒有注意到它。通過查看[入門文檔](http://rubydoc.info/docs/yard/file/docs/GettingStarted.md#Reference_Tags) – kmikael

+1

中的示例並不十分清楚,確實很容易錯過該參數名稱在那裏需要。很高興我能幫助你,歡呼! – keymone

+3

從0.8.7.3碼開始,語法是'@param name [Types] description'。 – karatedog