Utilizarea comentariilor în Ruby

Comentariile din codul dvs. Ruby sunt note și adnotări menite să fie citite de alți programatori. Comentariile în sine sunt ignorate de interpretul Ruby, astfel încât textul din comentarii nu este supus niciunei restricții.

De obicei, este o formă bună de a pune comentarii înainte de clase și metode, precum și orice bucată de cod care poate fi complexă sau neclară.

Utilizarea eficientă a comentariilor

Comentariile trebuie utilizate pentru a oferi informații de fundal sau pentru a adnota codul dificil. Notele care spun pur și simplu ceea ce face următoarea linie a codului simplu nu numai că sunt evidente, dar adaugă și dezordine la fișier.

Este important să aveți grijă să nu folosiți prea multe comentarii și să vă asigurați că comentariile făcute în fișier sunt semnificative și de ajutor pentru alți programatori.

Shebang

Veți observa că toate programele Ruby încep cu un comentariu care începe cu #!. Aceasta se numește a shebang și este utilizat pe sistemele Linux, Unix și OS X.

Când executați un script Ruby, shell-ul (cum ar fi bash pe Linux sau OS X) va căuta un shebang la prima linie a fișierului. Învelișul va folosi apoi shebang-ul pentru a găsi interpretul Ruby și pentru a rula scriptul.

Shebang-ul Ruby preferat este #! / usr / bin / env ruby, deși poate vedeți și voi #! / Usr / bin / rubin sau #! / Usr / local / bin / rubin.

Comentarii cu o singură linie

Comentariul cu o singură linie Ruby începe cu # caracter și se termină la sfârșitul liniei. Orice personaje din # caracterul până la sfârșitul liniei sunt complet ignorați de interpretul Ruby.

# caracterul nu trebuie să apară neapărat la începutul liniei; poate apărea oriunde.

Următorul exemplu ilustrează câteva utilizări ale comentariilor.

 #! / usr / bin / env ruby

 # Această linie este ignorată de interpretul Ruby

 # Această metodă imprimă suma argumentelor sale

 def sumă (a, b)

   pune a + b

 Sfârșit

 suma (10,20) # Tipăriți suma de 10 și 20 

Comentarii cu mai multe linii

Deși de multe ori uitată de mulți programatori Ruby, Ruby are comentarii cu mai multe linii. Un comentariu cu mai multe linii începe cu = începe jeton și se termină cu = end jeton.

Aceste jetoane ar trebui să înceapă de la începutul liniei și să fie singurul lucru pe linie. Orice dintre aceste două jetoane este ignorat de interpretul Ruby.

 #! / usr / bin / env ruby

 = începe

 Între = începe și = sfârșit, orice număr

 de linii pot fi scrise. Toate acestea

 liniile sunt ignorate de interpretul Ruby.

 = end

 pune "Hello lume!"

În acest exemplu, codul se va executa ca Salut Lume!