在院子里用@param标签警告

Question

我试图记录一些使用的Ruby代码yard,即使我正在完成这里或这里描述的内容

# @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

我能做错什么？

Answer 1

doc说@param标签有格式

@param [Type] name description

并且你的行不包括param名称(分别为n和p)