Attributy: id="rdoc" xreflabel="RDoc"

Rdoc je jednoduchá aplikace jenž extrahuje ze zdrojových kódu dokumentaci. Využívá přitom značkovacího jazyka podobného RD ale jednoduššího a znalosti syntaxe jazyka Ruby.

Program rdoc který je součástí distribuce ruby slouží k vytváření standardní dokumentace. Dokumentace se vytváří z odpovídajícím způsobem formátovaných komentářů a samotného zdrojového kódu.

Vytváří strukturovanou HTML a XML dokumentaci ze zdrojů psaných v Ruby a z rozšíření psaných v C.

Pro zápis textu, který má být v dokumentaci platí určitá pravidla. V dokumentaci jsou texty získané z komentářů které se nachází před definicí takových částí programu jako jsou třídy a metody. V komentářích je možno použít značkovacího jazyka který v ukázce uvedu.

#
# Toto je první odstavec.
#
# Odstavce jsou od seb odděleny prázdnými řádky.
#
# = Nadpis
# == Podnadpis
# === Podnadpis více zanořený
# Zanoření podnadpisů může být jěště větší
#
# = Příklad
#
#  Tento text je zobrazen fontem pevné šířky a je zachováno řádkování.
#   rdoc jej pozná tak že je odsaten od začátku řádku.
#
# = Seznamy
# * Volba obyčejného seznamu je uvozena znakem '*' nebo '-'
# * Další volba
#
# 1. Číslované seznamy začínají číslem.
# 9. Na velikosti čísla ani na pořadí nezáleží.
# 1. Je možné používat pořád to samé číslo.
#
# Pro zvýraznění textu je možno použít _kurzívu_ nebo <i>je-li slov více</i>.
# Dále _tučné_ písmo nebo <b>je-li slov více</b>.
# Také +code+ když potřebujeme font s pevnou šířkou nebo <tt>je-li slov více</tt>.
#
# Slovníkový seznam se zapisuje pomocí hranatých závorek:
# [první slova] Význam termínu.
# [další] Význam termínu 'další'.
#