Komentáře ve vašem Rubín kód jsou poznámky a anotace určené pro čtení jinými programátory. Ruby interpret ignoruje samotné komentáře, takže text uvnitř komentářů nepodléhá žádným omezením.
Obvykle je dobré umístit komentáře před třídami a metodami a také před jakýkoli kus kódu, který může být složitý nebo nejasný.
Efektivní použití komentářů
Komentáře by měly být použity k poskytnutí informací o pozadí nebo anotování obtížného kódu. Poznámky, které jednoduše říkají, co dělá následující řádek přímého kódu, jsou nejen zřejmé, ale také do souboru přidávají nepořádek.
Je důležité, abyste nepoužívali příliš mnoho komentářů, a ujistěte se, že komentáře obsažené v souboru jsou smysluplné a užitečné pro ostatní programátory.
Šebang
Všimněte si, že všechny programy Ruby začínají komentářem, který začíná #!. Tomu se říká a Shebang a je používán v systémech Linux, Unix a OS X.
Když spustíte skript Ruby, shell (například bash v systému Linux nebo OS X) vyhledá shebang na prvním řádku souboru. Shell pak použije shebang k nalezení Ruby interpretu a spuštění skriptu.
Preferovaný Ruby shebang je #! / usr / bin / env ruby, ale můžete také vidět #! / usr / bin / ruby nebo #! / usr / local / bin / ruby.
Jednořádkové komentáře
Jeden řádek Ruby začíná poznámkou # znak a končí na konci řádku. Jakékoli postavy z # Znaky do konce řádku jsou interpretem Ruby zcela ignorovány.
# postava se nemusí nutně vyskytovat na začátku řádku; to může nastat kdekoli.
Následující příklad ilustruje několik použití komentářů.
#! / usr / bin / env ruby
# Tato linka je ignorována interpretem Ruby
# Tato metoda vytiskne součet jejích argumentů
def sum (a, b)
dá a + b
konec
součet (10,20) # Tisk součtu 10 a 20
Víceřádkové komentáře
Ačkoli mnozí programátoři Ruby často zapomněli, Ruby má víceřádkové komentáře. Víceřádkový komentář začíná znakem = začátek token a končí znakem = konec žeton.
Tyto tokeny by měly začínat na začátku řádku a být jedinou věcí na řádku. Ruby interpret ignoruje cokoli mezi těmito dvěma žetony.
#! / usr / bin / env ruby
= začátek
Mezi = začátek a = konec, libovolné číslo
řádků. Všechny tyto
linky jsou ignorovány interpretem Ruby.
= konec
klade „Ahoj svět!“
V tomto příkladu by se kód spustil jako Ahoj světe!