Comentarii în TypeScript
Codul nu este scris doar pentru calculator, ci și pentru oameni: colegii tăi și tu, peste câteva luni. Comentariile sunt note în cod pe care compilatorul 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 finalul rândului este comentariu. Poate sta pe un rând separat sau la finalul unei instrucțiuni:
// Afișăm un mesaj de bun venit
console.log('Bun venit!');
console.log('Coșul este gol.'); // mesaj pentru client nouBun venit! Coșul este gol.
În consolă apar doar cele două mesaje. Comentariile nu se afișează.
Scrie un program cu un comentariu pe mai multe linii la început (descrierea programului), un comentariu pe o linie și o singură instrucțiune care afișează Magazinul este deschis..
- Adaugă la început un comentariu /* ... */ pe cel puțin două rânduri, care descrie programul.
- Adaugă un comentariu //.
- Afișează exact Magazinul este deschis. cu un singur console.log.
Soluția exercițiului
/*
Program pentru magazin:
anunță clienții că magazinul este deschis.
*/
// mesajul pentru clienți
console.log('Magazinul este deschis.'); Vrei să afli mai mult?Ce este un comentariu? · Comentarii pe mai multe linii: /* */ · Cod comentat: „oprește” temporar o linie · Comentarii bune și comentarii inutile · Pe scurt
Ce este un comentariu?
Un comentariu este un text din program care nu se execută. Compilatorul îl sare, ca și cum nu ar exista. Comentariile explică ce face codul sau de ce a fost scris așa.
Un program scris azi va fi citit de zeci de ori mai târziu. Un comentariu bun economisește minute întregi de „ce voiam să fac aici?”.
Comentarii pe mai multe linii: /* */
Pentru explicații mai lungi, comentariul începe cu /* și se termină cu */. Tot ce e între ele este ignorat, oricâte rânduri ar avea:
/*
Programul afișează programul magazinului.
Autor: echipa Academiei Programatorilor
*/
console.log('Luni - Vineri: 9:00 - 18:00');
console.log('Sâmbătă: 10:00 - 14:00');Luni - Vineri: 9:00 - 18:00 Sâmbătă: 10:00 - 14:00
Dacă scrii /* și uiți */, tot restul fișierului devine comentariu. Compilatorul îți va spune '*/' expected.
Cod comentat: „oprește” temporar o linie
Comentariile sunt utile și ca să dezactivezi o instrucțiune fără să o ștergi. Pui // în fața ei și linia nu mai rulează:
console.log('Pasul 1: verificăm coșul');
// console.log('Pasul 2: mesaj de test, nu îl mai afișăm');
console.log('Pasul 3: trimitem comanda');Pasul 1: verificăm coșul Pasul 3: trimitem comanda
Programatorii fac asta des când caută o greșeală: opresc pe rând câte o linie și văd ce se schimbă. Când ai terminat, ștergi // și linia funcționează din nou.
Comentarii bune și comentarii inutile
| Comentariu | Este util? |
|---|---|
| // afișează Salut deasupra lui console.log('Salut') | Nu: repetă ce se vede deja în cod. |
| // prețurile sunt cu TVA inclus | Da: spune ceva ce codul nu arată. |
| // TODO: adaugă livrarea gratuită peste 200 lei | Da: notează ce mai e de făcut. |
- Scrie comentarii care explică de ce, nu ce face o linie evidentă.
- Ține comentariile la zi: un comentariu vechi și greșit e mai rău decât niciunul.
- TODO este o convenție folosită de toți programatorii pentru „de făcut mai târziu”.
Pe scurt
Pentru note scurte, pe rând separat sau la final de instrucțiune.
Pentru descrieri mai lungi, de exemplu la începutul unui fișier.
Un // în fața unei linii o oprește temporar, fără să o ștergi.
