YARD 真实性公约

Question

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

Truthy下面通常用什么来代替？

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

我在文档中找到的最接近的是布尔值，这并不是我真正想要的。

Answer 1

使用布尔值以外的任何值都意味着您正在执行某种特殊处理，例如解释0为错误或比真/假检查更不字面的内容。

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