如何使用 Yard 记录枚举类型及其包含的类型?
使用 ruby Yard 文档工具,我可以编写
# @param bar [String]
def foo(bar)
end
但是如果参数是可枚举的,
# @param bar [Enumerable[String]]
def foo(bar)
end
上面的方法是否正确?
Using the ruby Yard doc tool I can write
# @param bar [String]
def foo(bar)
end
however if the parameter is an enumerable
# @param bar [Enumerable[String]]
def foo(bar)
end
Is the above the correct way or not?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
这样做:
参考:http://rubydoc.info/docs/码/文件/docs/GettingStarted.md#Declaring_Types
Do it like this:
Reference: http://rubydoc.info/docs/yard/file/docs/GettingStarted.md#Declaring_Types