14.1. RD

14.1.1. Nadpisy/Titulky
14.1.2. Průběžné značení textu, zvýrazňování textu
14.1.3. Seznamy

section id="rd" xreflabel="RD"

Odkazy a zdroje:

ToDo

  1. První úkol.

RD je dokumentační formát pro psaní „vnořené dokumentace“, tedy dokumentace která je součástí zdrojového kódu. V RD píšeme čistý text obohacený o několik druhů značek. Jedná se vlastně o velmi jednoduchý značkovací jazyk.

Protože píšeme dokumentaci i program v jednom, musí nějak ruby i další programy rozlišit text od kódu. K tomuto jsou určeny značky

=begin
=end

Vše mezi nimi je považováno za dokumentaci.

Řádky začínající '---' jsou speciálním případem labeled list, kde label je název metody a signatura.

Licence Creative Commons
Tento dokument Ruby, jehož autorem je Radek Hnilica, podléhá licenci Creative Commons Uveďte autora-Nevyužívejte dílo komerčně-Zachovejte licenci 3.0 Česká republika .