» Pagina principala » PHP si mysql » Documentarea unui script PHP

Documentarea unui script PHP

In afara de a furniza nume descriptive fisierelor care contin scripturile dvs. PHP, trebuie sa includeti in fiecare script atat comentarii care sa permita unui cititor sa determine cu usurinta utilitatea scriptului, cat si alte informatii referitoare la script. De exemplu, puteti include un comentariu care precizeaza numele fisierului care contine scriptul, astfel incat acesta sa apara in fersiunile tiparite ale scriptului. Iata un model sintactic pentru comentariile PHP:
// Scrieti aici comentariul dvs.
Dupa cum se poate vedea, un comentariu incepe cu doua caractere slash, urmate de un spatiu. In continuare, linia contine comentariul, care poate include orice caractere doriti, inclusiv caractere speciale.
O modalitate de a crea un comentariu pe mai multe linii este de a incepe fiecare linie cu ajutorul caracterelor //. Totusi, puteti crea un comentariu din mai multe linii si in alte moduri, daca preferati. Iata un exemplu:
/*
Acesta este un comentariu pe mai multe linii.
Poate fi alcatuit dintr-un numar oricat de mare de linii.
*/
Pentru a incepe un comentariu alcatuit din mai multe linii, scrieti caracterele /*, iar pentru a incheia comentariul, scrieti caracterele */ Intre cele doua perechi de caractere, puteti scrie orice text doriti, folosind oricate linii doriti.

Link-ul autorului:
www.tutoriale.far-php.ro