使用'yard'，我如何记录像“def foo（* args）”这样的通配符参数

Question

说我有这样的方法

# @return [Integer] number of arguments provided to the method
def return_number_of_arguments(*args)
  return args.length
end

我如何添加@param文档？

我的想法：

@param [*Object] any objects

但我在the yard docs

中找不到任何内容

Answer 1

由于args会在方法正文中显示为Array，我会写

# @param args [Array] elements to count
# @return [Integer] number of arguments provided to the method
def return_number_of_arguments(*args)
  return args.length
end