Komentarji za Ruby Code (Uporaba, Eno in več vrstic)

Komentarji v vašem Ruby koda so beležke in pripombe, ki naj bi jih prebrali drugi programerji. Tolmač Ruby tolmači ne upošteva samih komentarjev, zato besedilo v komentarjih ni predmet nobenih omejitev.

Ponavadi je dobra oblika, da pred predavanja in metode dodate komentarje, pa tudi katerikoli del kode, ki je lahko zapleten ali nejasen.

Pripombe je treba uporabiti za podajanje osnovnih informacij ali pripombe na težko kodo. Opombe, ki preprosto povedo, kaj počne naslednja vrstica preproste kode, niso samo očitne, temveč dodajo nered v datoteko.

Pomembno je, da ne uporabljate preveč komentarjev in da so komentarji v datoteki smiselni in koristni drugim programerjem.

Opazili boste, da se vsi programi Ruby začnejo s komentarjem, ki se začne s #!. To se imenuje a shebang in se uporablja v sistemih Linux, Unix in OS X.

Ko izvedete skript Ruby, bo lupina (na primer bash v Linuxu ali OS X) iskala shebang v prvi vrstici datoteke. Lupina bo nato uporabila shebang, da bi našla tolmača Ruby in zagnala skript.

Najprimernejši Ruby shebang je #! / usr / bin / env rubin, čeprav boste morda tudi videli #! / usr / bin / ruby ali #! / usr / local / bin / ruby.

Komentar Ruby z eno vrstico se začne z # znak in se konča na koncu vrstice. Kateri koli znaki iz # tolmač Ruby popolnoma ne upošteva znakov do konca vrstice.

The # ni nujno, da se znak pojavi na začetku vrstice; lahko se pojavi kjer koli.

Naslednji primer prikazuje nekaj uporab pripomb.

 #! / usr / bin / env rubin

 # Prevajalec Ruby te vrstice ne upošteva

 # Ta metoda natisne vsoto svojih argumentov

 def vsota (a, b)

 postavlja + b

 konec

 vsota (10,20) # Natisnite vsoto 10 in 20 

Čeprav jo mnogi programerji Ruby pozabijo, ima Ruby več komentarjev. Komentar z več vrsticami se začne z = začeti žeton in konča s = konec žeton.

Ti žetoni bi se morali začeti na začetku vrstice in biti edina stvar na liniji. Tolmač Ruby tolmači med tema dvema žetonoma ignorira.

 #! / usr / bin / env rubin

 = začeti

 Med = začetek in = konec, poljubno število

 vrstic se lahko napišejo. Vse to

 tolmač Ruby ne upošteva vrstic.

 = konec

 postavi "Pozdravljeni svet!"

V tem primeru bi se koda izvršila kot Pozdravljen, svet!