在院子里用@param标签警告

Question

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

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

并且您的行不包含参数名称（分别为n和p）