Komentáre vo vašom rubín kód sú poznámky a anotácie určené na čítanie inými programátormi. Interpret Ruby ignoruje samotné komentáre, takže text v komentároch nepodlieha žiadnym obmedzeniam.
Zvyčajne je dobré umiestniť komentáre pred triedy a metódy, ako aj pred akýkoľvek kód, ktorý môže byť zložitý alebo nejasný.
Efektívne využívanie komentárov
Komentáre by sa mali použiť na poskytnutie základných informácií alebo anotácie zložitého kódu. Poznámky, ktoré jednoducho hovoria, čo robí nasledujúci riadok jednoduchého kódu, sú nielen zrejmé, ale do súboru tiež pridávajú neporiadok.
Je dôležité, aby ste nepoužívali príliš veľa komentárov a aby ste sa uistili, že komentáre v súbore sú zmysluplné a užitočné pre iných programátorov.
Šebang
Všimnite si, že všetky programy Ruby začínajú komentárom, ktorý začína #!. Toto sa nazýva a shebang a používa sa v systémoch Linux, Unix a OS X.
Keď spustíte skript Ruby, shell (napríklad bash v systéme Linux alebo OS X) bude hľadať shebang na prvom riadku súboru. Shell potom použije shebang na nájdenie tlmočníka Ruby a spustenie skriptu.
Preferovaný Ruby shebang je #! / usr / bin / env ruby, ale môžete tiež vidieť #! / Usr / bin / ruby alebo #! / Usr / local / bin / ruby.
Jednoriadkové komentáre
Jednoradový komentár v Ruby sa začína znakom # znak a končí na konci riadku. Akékoľvek znaky z # Znaky do konca riadku tlmočník Ruby úplne ignoruje.
# postava sa nemusí nutne vyskytovať na začiatku riadku; môže sa vyskytnúť kdekoľvek.
Nasledujúci príklad ilustruje niekoľko použití komentárov.
#! / usr / bin / env ruby
# Tento riadok ignoruje tlmočník Ruby
# Táto metóda vytlačí súčet jej argumentov
def sum (a, b)
dá a + b
koniec
súčet (10,20) # Tlač súčet 10 a 20
Komentáre s viacerými riadkami
Aj keď mnohí programátori Ruby zabudli, Ruby má viac riadkové komentáre. Viacriadkový komentár začína znakom = začiatok token a končí znakom = koniec tokenu.
Tieto tokeny by mali začínať na začiatku riadku a byť jedinou vecou na riadku. Ruby interpret ignoruje čokoľvek medzi týmito dvoma tokenmi.
#! / usr / bin / env ruby
= začiatok
Medzi = začiatok a = koniec, akékoľvek číslo
riadkov možno zapísať. Všetky tieto
linky sú ignorované interpretom Ruby.
= koniec
kladie „Ahoj svet!“
V tomto príklade by sa kód spustil ako Ahoj svet!