يعد RDoc و YARD أداتي التوثيق المعياريتين لـ Ruby، حيث تقومان بتحليل تعليقات الكود لتوليد وثائق API تفاعلية.
نمط توثيق الدوال (Method Documentation Pattern)
# 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} # رابط إلى دالة فئة
التوجيهات الخاصة (Special Directives)
# إخفاء الدالة أو الفئة من الوثائق المنشأة
def internal_secret # :nodoc:
end
# توثيق توقيع تسلسل استدعاء محدد
# :call-seq:
# format(val) -> String
# format(val, options) -> String