ruby - 在 Ruby 中使用 TomDoc,表示 splat 参数的正确方法是什么?

标签 ruby tomdoc

TomDoc format 未能给出 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

最佳答案

缺少来自 TomDoc 的规则,您拥有的是合理的。所需要做的就是很好地记录参数,以便该方法的用户知道如何调用它。

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

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

关于ruby - 在 Ruby 中使用 TomDoc,表示 splat 参数的正确方法是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/29132225/

相关文章:

ruby - 在 OpenSUSE 上构建的鞋子 - Rake 错误

Ruby zlib deflate 海量数据

ruby-on-rails - 使用 bundle exec 运行 Rails 控制台

ruby - 使用自定义排序首选项对数组进行排序?

ruby-on-rails - 在 Rails 3 中使用 Devise 测试 'current_user'