如何使用Yard来记录可枚举类型及其包含的类型?

时间:2011-08-22 07:31:07

标签: ruby enumerable yard

使用ruby Yard doc工具我可以写

# @param bar [String]
def foo(bar)
end

但是,如果参数是可枚举的

# @param bar [Enumerable[String]]
def foo(bar)
end

上述方法是否正确?

1 个答案:

答案 0 :(得分:2)

这样做:

# @param [Enumerable<String>] bar
def foo(bar)
end

参考:http://rubydoc.info/docs/yard/file/docs/GettingStarted.md#Declaring_Types