ruby - 带有@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

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