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
Встроенная разметка (Inline Markup)
*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