RDoc et YARD sont les outils de documentation standard de Ruby, générant de la documentation d'API navigable.
Modèle de documentation de méthode
# 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
Balisage et formatage inline
*bold text*
_emphasized text_
+code or monospace+
{ClassName} # Lien vers la classe
{ClassName#method} # Lien vers la méthode d'instance
{ClassName.method} # Lien vers la méthode de classe
Directives spéciales
# Masquer la méthode ou la classe de la documentation générée
def internal_secret # :nodoc:
end
# Documenter une signature d'appel spécifique
# :call-seq:
# format(val) -> String
# format(val, options) -> String