YARD 如何记录返回固定大小数组的方法的 @return 类型？

Question

我有以下方法：

def foo
  [true_or_false, some_integer]
end

它总是返回一个由 2 组成的数组，其中第一个元素是布尔值，第二个元素是整数。 如何使用

@return

元标记在 YARD 中记录它？

后面就是这样使用的：

is_success, exit_code = foo

我已经检查了@return 部分的官方文档，但没有多大帮助。

Answer 1

# @return [Array(Boolean, Number)] fixed-size array(vector) of a boolean followed by a number
def foo
  [true_or_false, some_integer]
end

---

请勿将其与其他类似的

@return

标签格式混淆：

# @return [Array<String, Symbol, #read>] an Array of (Strings, Symbols, objects that respond to #read)

适用于不同数据类型的可变长度数组，不适用于固定长度向量。