Cum se face comentarii despre PHP: 3 pași

Comentariul este un tip de notă care poate fi folosit pentru a explica scopul și valorile fragmentului de cod. Lucrând în PHP, veți avea mai multe opțiuni pentru scrierea de comentarii care au trecut de la vechile limbi de programare bine-cunoscute: prin introducerea comentarii cu o singură linie sau multi-linie. Puteți utiliza comentariile pentru a nu oferi un fragment al codului pentru a câștiga sau pentru a înregistra înregistrări.

Pași

Partea 1 din 2:

Stiluri

unu. Comentarii cu o singură linie pentru înregistrările scurte. Dacă aveți nevoie să lăsați un comentariu scurt, utilizați codul de comentarii cu o singură linie. Comentariul dictează numai la sfârșitul liniei sau la sfârșitul blocului de cod. Astfel de comentarii funcționează numai în interiorul etichetelor PHP și vor fi citite numai dacă le puneți în HTML.

// Acesta este un mod standard (C ++) mod de a crea un comentariu cu o singură linie. Pentru a crea un comentariu cu o singură linie. De asemenea, puteți utiliza acest stil Unix ?>

2. Pentru a scrie comentarii lungi sau cod de testare, utilizați comentarii multi-line. Comentariile multi-line sunt foarte utile atunci când scrieți explicații lungi și pentru a preveni procesarea segmentului de cod. Citiți secțiunea "Utilizați" pentru a afla câteva sfaturi privind utilizarea comentariilor multiple.

/ * Acesta este modul în care merită un comentariu formatimnostrophive. Întregul manual al sfârșitului etichetei va include un comentariu * // * Unii îi place să pornească * în partea de sus a fiecărei linii * markeri suplimentari. Acesta va îmbunătăți * lizibilitatea comentariilor mari, deși nu este obligatorie. * /?>

Partea 2 din 2:

Utilizare

unu. Utilizați comentarii pentru lăsarea notelor pentru eficiența codului. Nu trebuie să faceți acest lucru pentru fiecare linie a codului, deoarece alți programatori pot găsi cu ușurință într-un cod bine scris. Comentariile sunt utile dacă codul îndeplinește funcții non-standard sau nu evidente.

// Creați o cerere curl $ sesiune = curl_init ($ solicitare) - // spuneți curl să utilizați http postcurl_setopt ($ sesiune, curlopt_post, adevărat)-

2. Lăsați comentarii să nu uitați ce ați făcut cu codul. Când lucrați la un proiect, comentariile nu vă vor lăsa să uitați ceea ce ați oprit. Lăsați comentarii pentru codul care funcționează incorect sau nu ați terminat încă.

// Înainte de a trece la pasul următor, trebuie să verificați dublu rezultatul acestui programCho "Salut Lume!"-

3. Lăsați un comentariu pentru codul pe care intenționați să îl împărțiți. Dacă intenționați să cooperați cu alți programatori sau veți face disponibil codul public, comentariile vor ajuta pe alții să înțeleagă cum funcționează codul dvs. și ce ar trebui corectat.

/ * Există o modalitate mai eficientă de a face?* / Sex: dacă (Isset ($ sex) && $ Gender =="Femeie") Ecou "Verificat"-?> Valoarea ="Femeie"> Femeie dacă (Isset ($ sex) && $ Gender =="Masculin") Ecou "Verificat"-?> Valoarea ="Masculin"> Bărbat

4. Lăsați comentarii pentru a anula blocurile de coduri specifice. Este destul de util atunci când testați codul și doriți să opriți munca unui fel de fragment. La pornirea paginii, tot ceea ce este inclus în eticheta de comentarii vor fi ignorate.

Ecou "/ * Salut Lume!"-/ * Când începeți codul menționat mai sus, cuvântul "salut" nu este reflectat * /?>

cinci. Aveți grijă atunci când comentați blocuri mari de cod. Funcția de comentare se va termina când câștigă prima marcă de completare, deci dacă în interiorul codului pe care l-ați comentat deja, este un comentariu multi-linie, se dovedește numai înainte de comentariul inițial.

/ * Echo "Salut Lume!"- / * Acest comentariu va strica * / * /?>

/ * Echo "Salut Lume!"- // Cu acest comentariu, totul va fi bine * /?>

6. Utilizați comentarii pentru a crea un pseudo-recorder. Puteți utiliza formate de coduri creative pentru a crea o înregistrare pentru cod direct în interiorul acestuia. Este destul de util pentru proiectele disponibile publicului.

// ============= // titlu //============ // ------------- // Subtitle // -------------- / * Numele secțiunii * / # Înregistrări Puteți scrie aici # a doua parte poate fi scrisă aici / * * Profitați de acest lucru pentru a explica: pentru care aveți nevoie mai multe linii * sau chiar câteva puncte de explicație * /?>

sfaturi

Comentariile HTML și PHP diferă unul de celălalt, deci când lucrați cu scenariile (combinația de HTML și PHP), asigurați-vă că utilizați sintaxa corectă.
De exemplu, în următorul cod există un comentariu HTML, dar acesta îndeplinește încă codul PHP. Dacă plasați comentariul HTML în interiorul etichetei PHP, acesta va rezulta.