在Ruby中使用TomDoc，表示splat参数的正确方法是什么？

Question

TomDoc格式未能给出splat参数的示例 - 应该怎么做？：

# Public: method to check allowed options.
#
# options  - Hash with options to check.
# *allowed - Splat Array with allowed options.
#
# Returns nothing.
def options_check(options, *allowed)
  # code here
end

Answer 1

缺乏TomDoc的规则，你所拥有的是合理的。所需要的只是很好地记录参数，以便该方法的用户知道如何调用它。

在这种情况下，虽然我不认为splat应该是名称的一部分，因为它不符合调用。最好添加一个用法示例，例如

# allowed - One or more options
#
# Examples
#
#   option_check({foo: :bar}, :baz, :qux, :quux)