ruby – 带有@param标签的院子警告

发布时间：2020-12-17 03:36:01 所属栏目：百科来源：网络整理

导读：我试图使用yard来记录一些 Ruby代码,即使我正在完成 here或 here所描述的内容 # @param [Integer] the number of trials (= 0)# @param [Float] success probability in each trialdef initialize(n,p) # initialize...end 我仍然得到这个奇怪的错误 @param

我试图使用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 doc -m markdown

我能做错什么？

解决方法

doc说@param标签有格式

@param [Type] name description

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

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!