如何在YARD中记录一个参数数目可变的函数？ [英] How can one document a function with a variable number of arguments in YARD?

问题描述

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

def myfun(*args)
  # ...
end

所有参数都属于同一类型(Symbol)，所以现在我对该函数进行了说明，就像只有一个参数一样，说它可以接受多个参数，例如：

# 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，尽管没有参数本身是Array：

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

注意，*从注释中的参数名称中删除。这只是为了保持一致-args是Array，但*args不是。

快速搜索会显示相当多使用此样式的项目，包括Yard自己的.rb文件(例如，请参阅source for initialize in Verifier class)--尽管指南中没有给出此约定的示例。

这篇关于如何在YARD中记录一个参数数目可变的函数？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！