komentari i komentiranje koda [PHP tutorial]

Svaki dobar programski kod, bez obzira na jezik u kojem je pisan sadrži velik broj komentara. Komentari pomažu prilikom kasnijih izmjena koda, nadogradnje ili ponovnog korištenja istog odsječka na nekom drugom mjestu. PHP nije nikakva iznimka, pa ćemo kao drugi dio ovih tutoriala o PHP-u naglasiti nekoliko važnih stvari o komentarima u PHP-u.

vrste komentara
PHP podržava dva osnovna tipa komentara – komentar kroz jedan red i komentar kroz više redova. No, teoretski, komentar je komentar, bio on kroz jedan ili više redova. Ono što je važno reći je da osim za komentiranje koda, komentare možemo koristiti i za “izbacivanje” nekog dijela koda i tako zaobići, preskočiti izvođenje tog dijela koda, bio to neki kontrolni ispis ili nešto sasvim treće.

komentar kroz jedan red
Za komentiranje koda ovim tipom komentara, sve što je potrebno napraviti je započeti komentar znakovima // ili znakom #. Time označavamo da je sve što se iza toga nalazi zapravo komentar, i prilikom izvršavanja PHP koda taj dio se preskače.
Primjer:

1
2
3
4
5
6
<?php
// pozdravimo svijet ispisivanjem teksta "pozdrav svijete!"
echo "Pozdrav svijete!";
 
# i sad oznake za kraj
?>

U drugom retku nalazi se jednostavni komentar koji govori što ćemo napraviti sljedećim retkom u kodu. U petom redu nalazi se također jedan komentar kojim smo opisali što dolazi na kraju. Koje oznake za komentar ćete koristiti? Vlastiti odabir, iako je oznaka // nekako prirodnija.

Primjer 2:

1
2
3
<?php
echo "Pozdrav svijete!"; // upravo smo pozdravili svijet!
?>

U primjeru 2 komentar se nalazi na kraju naredbe iza točke-zareza i komentira što smo napravili tim retkom koda. Komentar završava na kraju reda – sve što se nalazi iza znaka za početak komentara kroz jedan red je komentar. Da bi bilo jasnije, primjer 3:

1
2
3
4
<?php
// echo "komentar";
echo "Pozdrav svijete!"; 
?>

U drugom redu nalazi se poziv funkcije echo koja ispisuje tekst. Kako se nalazi iza znakova za komentar, to zapravo nije poziv funkcije, već komentar i neće se izvršiti – tekst “komentar” neće se ispisati na ekranu.

Naravno, ako je potrebno, možemo imati i nekoliko komentara kroz jedan redak uzastopno.

1
2
3
4
5
6
7
8
9
10
<?php
// ovo je jednostavna skripta za pocetak
// skripta ispisuje jednostavan tekst
 
// ispisujemo tekst "Pozdrav svijete!"
echo "Pozdrav svijete!"; 
// ne zaboravimo tocku-zarez na kraju!
 
// kraj skripte
?>

komentari kroz više redaka
Ovaj komentar se najčešće koristi kad je potrebno napisati neki veći komentar koji bi bio nepregledan u jednom redu kao što su upute za korištenje funkcije ili cijele klase.
Ovaj komentar započinjemo znakovima /** a završavamo znakovima */. Neki editori prilikom prelaska u novi red automatski na početak reda dodaju znak * sve dok mi ne unesemo znakove */ kojima označavamo kraj komentara. Dakle, komentar je sve što se nalazi između znakova /** i znakova */, bez obzira bio to jedan red ili njih 10 000.

1
2
3
4
5
6
7
8
9
<?php
/** komentar kroz vise redova, a samo je u jednom redu :) */
 
echo "Pozdrav svijete!"; 
/** pozdravili smo svijet
 * sad mozemo krenuti na neke zanimljivije stvari
 * komentare cemo koristiti jako cesto
 */
?>

Ukoliko želimo zakomentirati veći dio koda, na primjer 100 redaka, slobodno u prvom redu stavimo oznaku za početak komentara, a u stotom za kraj, pas e taj odsjećak koda neće izvršiti.

1
2
3
4
5
6
7
8
9
10
11
<?php
echo "Pozdrav svijete!"; 
 
/**
echo "jos jedan pozdrav svijetu!";
echo "zasto se ovo ne ispisuje na ekranu?";
echo "jel mozda zato sto je zakomentirano?";
echo "vrlo vjerojatno jer je sve ovo zakomentirano";
echo "da, bas zato";
*/
?>

Komentirajte. Što programski kod, što ovaj tekst. :)

tagovi: : comments, komentari, PHP code, PHP kod

2 komentara za članak “komentari i komentiranje koda [PHP tutorial]”

  1. ja :

    ja o probavam ovo

  2. ventolin online :

    I have the [b]viagra find edinburgh charles pages[/b] in the and as i recall, it took than a for me to any changes.

ostavite komentar