ruby - YARD 真实性公约

Question

是否有约定表明 YARD 样式文档中的参数仅用于其“真实性”状态，即您只想知道它是 false 还是 nil 还是真实的？

下面通常用什么代替 Truthy？

# @param [String] name
# @param [Truthy] admin_status 
def create_user(name, admin_status)
  # code goes here
end

我能在 documentation 中找到最接近的是 bool 值，这不是我真正想要的。

Answer 1

使用 Boolean 以外的任何东西都意味着您正在进行某种特殊处理，例如将 0 解释为 false 或比 true/false 检查更不直接的东西。

您可以看到 YARD docs 中使用的约定其中 Boolean 代表 TrueClass 和 FalseClass 类型。这种类型不然而，存在于 Ruby 中。