4.3. Komentáře a vložená dokumentace

Attributy: id="comments"

Odkazy:

Komentáře se v Ruby zapisují pomocí znaku #. Vše od tohoto znaku až do konce řádku je komentář. Komentáře mohou být tedy jak na samostatných řádcích.

# Toto je komentář na samostatném řádku.
# Následovaný dalším řádkem s komentářem.

Kometáře mohou být taky na koncích řádků s programem.

def fact n
    case n
        when 0,1: 1             # ošetření speciálních hodnot
        else n * (fact n-1)     # rekurze
    end
end

Varování

V ukázce je použit poetický zápis parametrů funkcí a neobvyklé závorkování.

Připomínám, pokud to není zcela zjevné, že pokud je znak # použit v zápisu řetězce tak není otevíracím znakem komentáře, rovněž pokud je použit v zápisu regulárního výrazu.

a = "sd#gf"
b = /#neco/

Zápis delších komentářů, a také pro vložené dokumentace se provádí pomocí =begin a =end.

=begin
Zde je velmi dlouhý
mnohařádkový komentář.
A nebo také vložená dokumentace.
=end

Připomínám že =begin a =end musí být na začátku řádku.

Za klíčovými slovy =begin a =end může být libovolný text, musí ovšem být oddělen alespoň jednou mezerou.

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 .