RDoc と YARD は、Rubyソースコード内のコメントを解析して閲覧可能なAPIドキュメントを生成する標準ツールです。
メソッドドキュメントの記述パターン
# Calculates total order price after applying discount vouchers.
#
# @example Applying a seasonal voucher
# calculator = PriceCalculator.new(order)
# calculator.final_total(voucher: 'SUMMER20') #=> 80.0
#
# @param voucher [String, nil] The voucher code to apply.
# @param tax_rate [Float] Applicable sales tax rate (default: 0.1).
# @return [Float] Total rounded price in USD.
# @raise [InvalidVoucherError] If voucher is expired or unrecognized.
def final_total(voucher: nil, tax_rate: 0.1)
# ...
end
インラインマークアップ書式
*bold text*
_emphasized text_
+code or monospace+
{ClassName} # クラスへのリンク
{ClassName#method} # インスタンスメソッドへのリンク
{ClassName.method} # クラスメソッドへのリンク
特殊ディレクティブ
# 生成されるドキュメントからメソッドやクラスを除外
def internal_secret # :nodoc:
end
# 特定の呼び出しシグネチャを明示
# :call-seq:
# format(val) -> String
# format(val, options) -> String