ce sunt comentarii în Ruby?
un comentariu Ruby adaugă informații la codul dvs. care pot fi utile pentru dvs. sau pentru alți dezvoltatori.
cel mai frecvent tip de comentariu este comentariul cu o singură linie.
Iată sintaxa:
# I like apples & oranges
observați trei lucruri:
- comentariul începe cu un simbol Lira (
#) - am pus un spațiu între conținutul comentariului& începutul comentariului pentru a face mai ușor de citit
- totul în interiorul comentariului nu este interpretat ca un cod, chiar dacă arată ca un cod. Aceasta înseamnă că puteți comenta temporar codul pentru a-l dezactiva.
puteți utiliza aceste comentarii pe cont propriu, sau inline, la sfârșitul unei linii de cod.
.size # get array size
există și alte tipuri de comentarii?
da, există comentarii magice, comentarii multilinie & comentarii ERB.
să le explorăm!
cum se utilizează Comentarii Multi-Line în Ruby
în Ruby, facem comentarii multilinie cu comentarii regulate, cu o singură linie.
unii oameni numesc aceste „comentarii bloc”.
Iată un exemplu:
# aaa# bbb# ccc
exact așa să comentezi un bloc de cod în ruby.
editorii de coduri moderne vă permit să selectați un bloc de cod & comentați totul folosind o comandă rapidă de la tastatură, astfel încât nu există niciun efort suplimentar implicat.
dar există o sintaxă specială de comentarii multilinie.
se pare ca acest lucru:
=beginThis is a comment...abc=end
nimeni nu folosește această sintaxă…
este urât & nici măcar nu îl poți folosi în interiorul a ceva care este indentat (ca o metodă), dar este bine să știi că există dacă îl găsești vreodată în sălbăticie.
SheBang Comments
un shebang (#!) este un tip special de comentariu care spune un shell Unix (cum ar fi bash) cum să interpreteze acest fișier.
când adăugați acest comentariu în partea de sus a fișierului…
veți putea rula fișierele Ruby ca fișiere executabile, presupunând că au permisiunile potrivite pentru a face acest lucru.
Iată cum arată un comentariu shebang:
#!/usr/bin/env ruby
acest lucru vă permite, de asemenea, să setați opțiuni specifice pentru linia de comandă, cum ar fi opțiunea de avertizare.
exemplu:
#!/usr/bin/env ruby -w
de fiecare dată când rulați acest cod, acesta va rula cu aceste opțiuni, deci nu trebuie să le transmiteți manual.
cum se utilizează comentariile magice
un comentariu magic schimbă într-un fel comportamentul interpretului Ruby.
de exemplu:
comentariul frozen_string_literals va face ca șirurile dvs. să fie înghețate în mod implicit.
se pare ca acest lucru:
# frozen_string_literal: true
un alt comentariu magic vă permite să modificați codificarea fișierului.
Iată un exemplu:
# encoding: utf-8
A iată unul interesant, comentariul warn_indent:
# warn_indent: true
aceasta va afișa un avertisment ori de câte ori indentarea dvs. este greșită.
exemplu:
def comments end
care are ca rezultat:
warning: mismatched indentations at 'end' with 'def' at 3
comentarii ERB
dacă utilizați ERB pentru vizualizările dvs. de șine & trebuie să adăugați un comentariu…
atunci puteți utiliza această sintaxă:
nu sunt un mare fan al acestui lucru, deoarece cred că ar trebui să vă păstrați cea mai mare parte a logicii din opiniile dvs., astfel încât să nu aveți nevoie de comentarii.
căutați să dezactivați un cod pentru depanare?
apoi ștergeți acel cod & trust git sau orice sistem de control al versiunii pe care îl utilizați.
rezumat
