ruby – 如何在YARD中记录具有可变数量参数的函数？

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

导读：我有一个函数,它接受可变数量的参数,如下所示： def myfun(*args) # ...end 所有args都是相同的类型(符号),所以现在我记录函数就像只有一个参数,说它可能需要多个,例如： # this function doesn’t do anything# @param [Symbol]: this argument does someth

我有一个函数,它接受可变数量的参数,如下所示：

def myfun(*args)
  # ...
end

所有args都是相同的类型(符号),所以现在我记录函数就像只有一个参数,说它可能需要多个,例如：

# this function doesn’t do anything
# @param [Symbol]: this argument does something,you can add more symbols
#                  if you want
def myfun(*args)
  # ...
end

是否有内置的方法来处理这种情况？

解决方法

以下是有意义的,因为args是方法内部的一个Array,尽管params都不是这样的数组：

# this function doesn’t do anything
#
# @param [Array<Symbol>] args these arguments do something
# @return [nil]
def myfun(*args)
  # ...
end

请注意*从注释中的param名称中删除.这只是为了保持一致 – args是一个数组,但* args不是.

快速搜索显示了很多使用此样式的项目,包括Yard自己的.rb文件(例如参见source for initialize in Verifier class) – 尽管指南中没有给出此约定的示例.

（编辑：李大同）

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