Comentarii în PHP
Comentariile sunt note pe care le scrii în cod pentru oameni, nu pentru calculator. PHP le ignoră complet. Ele te ajută să explici ce face programul, să lași notițe colegilor și să dezactivezi temporar o bucată de cod.
Comentarii pe un singur rând: // și #
Tot ce urmează după // sau după #, până la capătul rândului, este ignorat:
<?php // Afișăm mesajul de bun venit echo "Bun venit!\n"; # Și acesta este un comentariu echo "Spor la învățat!\n"; // comentariu la final de rând
Bun venit! Spor la învățat!
// este forma cea mai folosită. # funcționează la fel, dar îl vei întâlni mai rar în codul modern.
Programul de pornire afișează trei rânduri, dar anunțul Reduceri: -50% a expirat. Fără să ștergi linia, dezactiveaz-o cu un comentariu //. Adaugă apoi la începutul programului un comentariu pe mai multe rânduri /* */ care descrie programul. Rezultatul trebuie să fie doar Magazinul este deschis și Vă așteptăm!, pe două rânduri.
- Pune // în fața liniei cu anunțul de reduceri.
- Adaugă un comentariu /* ... */ la început.
- Nu modifica celelalte două instrucțiuni echo.
Soluția exercițiului
<?php /* Program: anunț pentru clienți Afișează starea magazinului. */ echo "Magazinul este deschis\n"; // echo "Reduceri: -50%\n"; echo "Vă așteptăm!\n";
Vrei să afli mai mult?De ce avem nevoie de comentarii? · Comentarii pe mai multe rânduri: /* */ · Dezactivarea temporară a codului · Comentarii bune și comentarii inutile · În viața reală
De ce avem nevoie de comentarii?
Un program poate avea sute de rânduri. Peste o lună nu-ți vei mai aminti de ce ai scris un anumit calcul. Un comentariu scurt explică intenția codului.
- Explici ce face o parte din program.
- Lași notițe pentru colegi (sau pentru tine din viitor).
- Dezactivezi temporar o linie fără să o ștergi.
Comentarii pe mai multe rânduri: /* */
Pentru explicații mai lungi, pui textul între /* și */. Tot ce e între ele este ignorat, oricâte rânduri ar avea:
<?php /* Program: mesaj pentru clienți Autor: echipa magazinului Afișează programul de lucru. */ echo "Luni - Vineri: 9:00 - 18:00\n";
Luni - Vineri: 9:00 - 18:00
Nu poți pune un /* */ în interiorul altui /* */. Primul */ întâlnit închide comentariul, iar restul devine cod și produce erori.
Dezactivarea temporară a codului
Uneori vrei să vezi cum se comportă programul fără o anumită instrucțiune. În loc să o ștergi, o comentezi:
<?php echo "Pasul 1\n"; // echo "Pasul 2\n"; echo "Pasul 3\n";
Pasul 1 Pasul 3
Linia cu Pasul 2 nu se mai execută. Când vrei să o readuci, ștergi // din fața ei.
Comentarii bune și comentarii inutile
| Inutil | Util |
|---|---|
| // afișez text deasupra unui echo | // prețurile includ deja TVA |
| repetă ce face codul | explică de ce face asta |
Un comentariu bun răspunde la întrebarea de ce?, nu la ce?. Codul clar arată singur ce face.
În viața reală
Într-o firmă, zeci de programatori citesc același cod; comentariile le economisesc timp.
Când cauți o greșeală, comentezi pe rând bucăți de cod ca să vezi unde apare problema.
Comentariile speciale /** */ de deasupra funcțiilor sunt folosite de editoare pentru a afișa ajutor.
