Komentarji v kodi pomagajo razložiti namen programa, označiti pomembne dele kode in olajšati vzdrževanje. PHP podpira enovrstične in večvrstične komentarje.
Osnovna pravila
- Enovrstični komentar začnemo z
//ali#. - Večvrstični komentar začnemo z
/*in zaključimo z*/. - Komentarji so namenjeni razlagi kode in se pri izvajanju programa ne izpišejo uporabniku.
- Dobri komentarji dopolnjujejo kodo, ne ponavljajo pa povsem očitnega.
Pomni: Komentarji so namenjeni predvsem programerjem. Pomagajo pri razumevanju kode, vendar ne vplivajo na rezultat izvajanja programa.
Enovrstični komentarji
Enovrstični komentar velja od mesta zapisa do konca vrstice. Zapišemo ga z // ali #.
// to je primer komentarja
# to je primer komentarja
Tak komentar je primeren za kratko pojasnilo ene vrstice kode ali za začasno izključitev posameznega ukaza.
Primer uporabe enovrstičnih komentarjev
<?php
echo "Pozdravljen svet!"; // ta ukaz izpiše besedilo
echo "<br>To je druga vrstica."; # tudi to je komentar
// echo "Ta ukaz se ne bo izvedel.";
?>To je druga vrstica.
Enovrstični komentar velja le do konca trenutne vrstice. Če se PHP blok zaključi z ?>, se komentiranje ne nadaljuje v naslednji HTML del dokumenta.
Večvrstični komentarji
Večvrstični komentar uporabimo, kadar želimo zapisati daljšo razlago ali začasno izključiti več vrstic kode.
/*
Ves tekst,
ki je med tema oznakama,
je komentar.
*/
<?php
/* Ta komentar lahko obsega
več vrstic. */
echo "Pozdravljen svet!";
/*
echo "Ta vrstica se ne bo izvedla.";
echo "Tudi ta vrstica se ne bo izvedla.";
*/
?>Pozor: Večvrstičnih komentarjev ne moremo gnezditi. Komentar se zaključi že pri prvem zapisu */, zato lahko nepravilno gnezdenje povzroči napako v kodi.
Primerjava vrst komentarjev
Obe vrsti komentarjev imata podoben namen, vendar se uporabljata v različnih primerih.
- Enovrstični komentar je primeren za kratka pojasnila ob eni vrstici kode.
- Večvrstični komentar je primeren za daljša pojasnila ali za začasno izključitev več vrstic kode.
Izbira ustrezne vrste komentarja prispeva k bolj pregledni in razumljivi kodi.
Priporočila
- Komentar naj pojasni namen kode, ne le ponovi zapisan ukaz.
- Komentarje uporabljajmo zmerno in smiselno.
- Za kratke opombe uporabljajmo enovrstične komentarje.
- Za daljše razlage ali začasno izključitev več vrstic uporabljajmo večvrstične komentarje.
- Komentarje je treba ob spremembah kode tudi posodabljati.
Pomni: Najboljši komentarji so kratki, jasni in vsebinsko uporabni. Njihova naloga je pojasniti namen, ne pa nadomestiti slabo napisano kodo.
Pogoste napake
- Komentarji zgolj ponavljajo tisto, kar je iz kode že očitno.
- Komentarji niso posodobljeni in ne ustrezajo več dejanskemu delovanju kode.
- Večvrstični komentar ni pravilno zaključen, zato pride do napake v programu.
- Uporabljeno je gnezdenje večvrstičnih komentarjev, ki v PHP ni dovoljeno.
- Preveliko število komentarjev zmanjšuje preglednost namesto da bi jo izboljšalo.
Pozor: Komentarji naj bodo v pomoč pri razumevanju kode. Nejasni, zastareli ali odvečni komentarji lahko preglednost programa celo zmanjšajo.