Ruby | RDocでドキュメントコメントの一部を出力対象外にする

概要

RDocでドキュメントコメントの一部を出力対象外にする

詳細

RDocでドキュメントコメントの一部を出力対象外にします。
メソッドヘッダーに記載はしておきたいが、APIドキュメントには含めたくないような
内容がある場合に出力対象外としたいです。

その場合は、下記のようにします。

#--
# この部分は出力対象外
#++

「#--」、「#++」で囲んだ範囲が出力対象外となります。