YARD 如何记录 Array<Array<String>> 的 @param

Question

假设我有以下功能：

@param foo [Array<String>]
def recursive_split(foo)
  bar = []
  foo.each do |elem|
    bar.append(elem.split(''))
  end
  bar
end

如何使用码 @return 标记记录我的 return 值是字符串数组？ @return [Array<Array<String>>] 是正确的做法吗？

Answer 1

docs aren't that specific 但类型说明符是递归的，因此 Array<X> 中的 X 可以是任何有效类型列表，因此这些：

Array<String>
Array<String, Symbol>
Array<Array<String, Symbol, #m>>
Array<String, Array<#m>>
...

都有效。

online type parser 可能是最简单的检查方法。也就是说 Array<Array<String>> 是：

an Array of (an Array of (Strings))

YARD how to document a @param of Array<Array<String>>