如何使用YARD的@return元标签标注返回固定大小二元数组的方法?
用YARD标注返回固定结构数组的方法
你需要的是YARD对固定元素类型和顺序的数组的标注语法,官方其实支持这种复合类型写法,只是可能你没留意到细节。
针对你这个返回[布尔值, 整数]的方法,正确的@return标签写法如下:
# 执行操作并返回结果状态与退出码 # @return [Array(Boolean, Integer)] 第一个元素表示操作是否成功(布尔值),第二个元素为退出码(整数) def foo [true_or_false, some_integer] end
语法说明:
Array(Boolean, Integer)是YARD的复合类型标注规则,明确指定数组包含两个元素:第一个必须是Boolean类型,第二个必须是Integer类型。- 这种写法完美适配你后续解构赋值的使用场景:
is_success, exit_code = foo,文档生成工具或IDE(比如RubyMine)能正确识别每个变量的类型,提升代码可读性和开发体验。
如果需要更清晰的语义,还可以在标签后补充每个元素的具体含义,就像示例里的注释那样,让其他开发者一眼就能理解返回值各部分的作用。
内容的提问来源于stack exchange,提问作者Nikita Fedyashev
相关产品推荐
相关产品推荐

