Să aflăm ce sunt comentariile și de ce sunt importante în programare.
De asemenea, acoperim două tipuri comune de comentarii și cum să le scriem în 15 limbaje de programare diferite.
Cuprins
Ce sunt comentariile în programare?
Comentariile în termeni profani sunt fragmente de text care nu vor fi vizibile pentru utilizatorii finali și sunt pentru referința persoanelor care scriu cod.
Puțin mai formal, Un comentariu este o descriere a unui program despre modul în care funcționează într-un format simplu care poate fi citit. Acestea sunt de obicei folosite în locuri în care trebuie furnizată o claritate suplimentară dezvoltatorului care citește codul. Astfel, acest lucru ajută la îmbunătățirea lizibilității codului și reduce timpul și comunicarea care ar fi necesare pentru transferul de cunoștințe.
Compilatorul/Interpretul pur și simplu ignoră comentariile din codul tău, fără a afecta rezultatul final al programului tău. Deci, pe scurt, comentariile sunt ca o simplă explicație lizibilă pentru anumite bucăți de cod.
Tipuri comune de comentarii
Majoritatea limbajelor de programare acceptă 2 tipuri de comentarii.
- Comentariu pe o singură linie
- Comentariu pe mai multe rânduri / Blocare comentarii
După cum sugerează și numele, comentariile pe o singură linie sunt utile atunci când trebuie să adăugați text mic pe o singură linie, de ex. o anumită condiție, o valoare constantă care necesită o mică descriere. În timp ce multi-line funcționează mai bine atunci când avem o cantitate mai mare de informații de adăugat, cum ar fi o descriere despre o funcție și cum se poate folosi, etc.
Există și alte tipuri de comentarii, cum ar fi comentariile documentelor, dar acest lucru nu intră în domeniul de aplicare al acestui articol.
De ce ar trebui să adăugați comentarii?
„Orice prost poate scrie cod pe care un computer îl poate înțelege. Programatorii buni scriu cod pe care oamenii îl pot înțelege.” – Martin Fowler
Avantajul major al adăugarii de comentarii este lizibilitatea îmbunătățită și înțelegerea mai bună a programului. În afară de aceasta, câteva alte avantaje includ:
- Comentariile fac foarte ușor pentru colegii tăi și chiar și pentru alți dezvoltatori să înțeleagă logica fără a citi documentații lungi.
- Comunicarea redusă între dezvoltatori pentru mici îndoieli
- Comentariile sunt ignorate de compilator/interpreți.
- Pentru software-ul cu sursă deschisă, acestea sunt o necesitate, deoarece nu veți fi acolo pentru a explica fiecare funcție pentru milioane de dezvoltatori care doresc să folosească acel program anume.
Comentarii în mai multe limbi
Minunat, acum că am aflat despre comentarii și de ce sunt utile. Să explorăm cum putem adăuga comentarii în diferite limbaje de programare.
Comentariu pe o singură linie
// This is a single line comment in C/C++
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in C/C++ */
Comentariu pe o singură linie
# This is a single line comment in Python
Comentariu pe mai multe rânduri
# This is slightly long # multi line comment in Python
Comentariu pe o singură linie
// This is a single line comment in Java
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in Java */
Comentariu pe o singură linie
# This is a single line comment in Ruby
Comentariu pe mai multe rânduri
=begin This is slightly long multi line comment in Ruby =end
Comentariu pe o singură linie
// This is a single line comment in Golang
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in Golang */
Comentariu pe o singură linie
– – This is a single line comment in Haskell
Comentariu pe mai multe rânduri
{- This is slightly long
multi line comment in Haskell -}
Comentariu pe o singură linie
// This is a single line comment in Rust
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in Rust */
Comentariu pe o singură linie
<!-- This is a single line comment in HTML -->
Comentariu pe mai multe rânduri
<!-- This is slightly long multi line comment in HTML -->
Comentariu pe o singură linie
/* This is a single line comment in CSS */
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in CSS */
Comentariu pe o singură linie
// This is a single line comment in Javascript
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in Javascript */
Comentariu pe o singură linie
# This is a single line comment in R programming language
Comentariu pe mai multe rânduri
R nu acceptă comentarii pe mai multe rânduri.
Comentariu pe o singură linie
% This is a single line comment in Erlang
Comentariu pe mai multe rânduri
R nu acceptă comentarii pe mai multe rânduri.
Comentariu pe o singură linie
// This is a single line comment in PHP
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in PHP */
Comentariu pe o singură linie
# This is a single line comment in Perl
Comentariu pe mai multe rânduri
=begin This is slightly long multi line comment in Perl =end
Comentariu pe o singură linie
// This is a single line comment in Kotlin
Comentariu pe mai multe rânduri
/* This is slightly long multi line comment in Kotlin */
Concluzie
Tutorialul a acoperit elementele de bază despre comentarii și 2 tipuri comune – Single și Multi-line. De asemenea, am încercat să aflu de ce sunt utile comentariile și ar trebui să le scrieți atunci când este necesar. Sper că ai învățat ceva nou!
Continuați să explorați. Continua sa inveti! 👨💻