コード日進月歩

プログラミングの技術的なメモなど

RubyにはBooleanというクラスは存在しないがYARDでは指定できる

YARDのドキュメントみたら、え、とおもったのでメモ

前提の話

RubyにはTrueClassとFalseClassしかなく、Booleanというクラスは存在しない。

x = true
=> true
x.class
=> TrueClass
x = false
=> false
x.class
=> FalseClass

YARDでの記載

[]内に複数指定できるので以下の書き方ができる。

# @param [true,false] 0を下回ればtrue,そうでなければfalse
def under_zero?(target)
  target.to_i < 0
end

が、ドキュメントを読むと [true,false] みたいなときは Boolean という書き方もできるよある、なので

# @param [Boolean] 0を下回ればtrue,そうでなければfalse
def under_zero?(target)
  target.to_i < 0
end

みたいに書ける、ただRuby初学者は普通に間違えそうだなって思ったり…

参考サイト