Comentarii în JavaScript
Codul nu este scris doar pentru calculator, ci și pentru oameni: pentru colegii tăi și pentru tine, peste câteva luni. Comentariile sunt notițe în cod pe care JavaScript le ignoră complet. În această lecție înveți cele două feluri de comentarii și când merită să le folosești.
Comentarii pe o linie: //
Tot ce urmează după //, până la sfârșitul rândului, este comentariu. Poți scrie comentariul pe un rând separat sau la finalul unei instrucțiuni:
// Programul afișează un mesaj de bun venit
console.log("Bun venit în magazin!"); // mesajul apare la deschiderea paginii
// console.log("Acest rând nu rulează");Bun venit în magazin!
S-a afișat un singur rând. Primul și ultimul rând sunt în întregime comentarii, iar la al doilea rând JavaScript execută instrucțiunea și ignoră textul de după //.
Programul din editor afișează acum trei rânduri. Folosește comentariile ca rezultatul să fie doar Comentariile nu se afișează, fără să ștergi niciun rând de cod.
- La început, adaugă un comentariu /* ... */ pe cel puțin două rânduri, cu numele tău și ce face programul.
- Comentează cu // linia care afișează Mesaj de test.
- Comentează cu /* ... */ cele două linii de la final, care afișează mesajele despre reducere.
- Rulează și verifică faptul că în consolă apare doar Comentariile nu se afișează.
Soluția exercițiului
/*
Autor: Ana Popescu
Programul arată că liniile comentate nu rulează.
*/
// console.log("Mesaj de test");
console.log("Comentariile nu se afișează");
/*
console.log("Reducere: 10%");
console.log("Reducerea expiră azi");
*/ Vrei să afli mai mult?Ce este un comentariu? · Comentarii pe mai multe linii: /* */ · „Oprirea” temporară a codului · Comentarii bune și comentarii inutile · Comentariile în proiecte reale
Ce este un comentariu?
Un comentariu este un text din cod pe care motorul JavaScript îl sare la rulare. Nu se execută și nu se afișează nicăieri. Rolul lui este să explice codul celui care îl citește.
Gândește-te la notițele de pe marginea unei rețete: „folosește unt nesărat” sau „nu deschide cuptorul în primele 20 de minute”. Rețeta funcționează și fără ele, dar notițele te ajută să o urmezi corect.
Comentarii pe mai multe linii: /* */
Pentru explicații mai lungi, folosești /* ca să începi comentariul și */ ca să îl închei. Tot ce este între ele, oricâte rânduri, este ignorat:
/*
Program: Salutul zilei
Autor: Ana Popescu
Afișează două mesaje pentru utilizator.
*/
console.log("Bună dimineața!");
console.log("Ai 3 sarcini pentru astăzi.");Bună dimineața! Ai 3 sarcini pentru astăzi.
Dacă uiți */, tot restul fișierului devine comentariu, iar programul nu mai face nimic (sau primești o eroare). Verifică mereu că fiecare /* are perechea lui */.
„Oprirea” temporară a codului
Comentariile sunt folosite și ca să dezactivezi temporar o bucată de cod, fără să o ștergi. Programatorii spun că „au comentat” codul:
console.log("Pasul 1: verific coșul");
// console.log("Pasul 2: aplic reducerea");
console.log("Pasul 3: trimit comanda");Pasul 1: verific coșul Pasul 3: trimit comanda
Pasul 2 nu a rulat. Dacă ștergi //, linia devine din nou cod și se execută. Este o metodă rapidă de a testa cum se comportă programul fără o anumită instrucțiune.
În majoritatea editoarelor (inclusiv în cel din dreapta), combinația Ctrl + / (pe Mac Cmd + /) comentează sau decomentează rândul pe care te afli.
Comentarii bune și comentarii inutile
Un comentariu bun explică de ce faci ceva, nu repetă ce se vede deja în cod.
| Comentariu | Este util? |
|---|---|
| // afișez Salut | Nu: se vede din cod că afișezi Salut. |
| // mesajul cerut de client pentru Black Friday | Da: explică motivul, care nu se vede din cod. |
| /* Autor, dată, ce face programul */ | Da: un antet scurt la începutul fișierului ajută echipa. |
- Scrie comentariile în limba echipei (aici, română) și păstrează-le scurte.
- Actualizează comentariul când schimbi codul: un comentariu greșit este mai rău decât niciunul.
- Nu lăsa pentru totdeauna bucăți mari de cod comentat: dacă nu mai ai nevoie de ele, șterge-le.
Comentariile în proiecte reale
Comentariile explică deciziile neobișnuite, ca un coleg să nu „repare” din greșeală ceva ce funcționa intenționat.
Bibliotecile mari descriu în comentarii ce face fiecare parte, iar editoarele afișează aceste explicații când scrii cod.
Când cauți o problemă, comentezi pe rând bucăți de cod ca să vezi care dintre ele o produce.
Pe scurt: // comentează până la finalul rândului; /* ... */ comentează oricâte rânduri; codul comentat nu rulează.
