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

发布于 2024-11-30 21:13:00 字数 214 浏览 1 评论 0原文

使用 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 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

盗琴音 2024-12-07 21:13:00

这样做:

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

参考:http://rubydoc.info/docs/码/文件/docs/GettingStarted.md#Declaring_Types

Do it like this:

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

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

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文