Cum să comentați pe PHP

Un comentariu este un tip de adnotare care poate fi folosit pentru a clarifica scopul unui fragment de cod. În PHP, există mai multe opțiuni de comentarii disponibile, dintre care două sunt influențate de limbile populare mai vechi, comentând doar o singură linie. Altul vă permite să comentați mai multe linii în același timp, ca și în limba C. Puteți utiliza comentariile pentru a împiedica executarea fragmentelor de cod sau chiar pentru a crea o documentație a programului.

conținut

Pași
Partea 1tipuri de comentarii
Partea 2aplicații
Sfaturi
Surse și cotatii

pași

Partea 1
Tipuri de comentarii

Utilizați comentarii de o singură linie pentru a face note scurte. În acest caz, zona de comentarii se va termina la sfârșitul liniei sau la sfârșitul blocului de cod. Aceste comentarii funcționează numai în interiorul tag-uri (markup) PHP, atunci ele vor fi citite doar dacă sunt plasate în interiorul HTML.

Utilizați mai multe linii de comentarii pentru a comenta fragmente mai mari de cod sau pentru a rula teste. Acest tip de comentariu este util pentru scrierea unei explicații îndelungate sau pentru împiedicarea executării unui segment de cod. Vedeți secțiunea "Aplicații" de mai jos pentru câteva sfaturi despre acest tip de comentariu.

Partea 2
aplicații

Utilizați comentariile pentru a lăsa sfaturi despre cum funcționează codul. Nu este nevoie să faceți acest lucru pentru toate liniile, deoarece un cod bun ar trebui să fie ușor de înțeles pentru alți programatori, dar comentariile sunt foarte utile pentru a explica diferite funcții sau dificil de înțeles.

// Generarea unei solicitări de curl $ session = curl_init ($ request) - // Spuneți curl pentru a utiliza HTTP POSTcurl_setopt ($ session, CURLOPT_POST, true) -

Lăsați comentarii astfel încât să vă puteți aminti ce ați făcut în trecut. Indiferent dacă lucrați la un proiect propriu, comentariile vă pot ajuta să vă amintiți unde ați rămas ultima oară. Lăsați comentarii despre fragmente de cod care nu funcționează sau nu au fost încă terminate.

// Este necesar să revizuiți rezultatele înainte de a continua.echo "Buna ziua!" -

Comentează codurile pe care vrei să le trimiți. Dacă aveți de gând să lucreze împreună cu alte persoane sau doresc să facă un proiect open source, comentariile vor fi foarte utile pentru a ajuta pe alții să înțeleagă codul de operare și în cazul în care pentru a face îmbunătățiri.

/ * Există o modalitate mai eficientă de a face acest lucru? * / Sex: Femeie Barbat

Utilizați comentariile pentru a împiedica executarea anumitor blocuri de cod. Acest lucru este foarte util pentru efectuarea de teste în cazul în care aveți nevoie de o bucată de cod pentru a nu rula. Tot ce se află în interiorul etichetelor va fi ignorat atunci când pagina se încarcă.

Aveți grijă când comentați blocuri mari de cod. Funcția de comentariu se va termina de îndată ce va fi găsit o etichetă finală, deci dacă există deja un comentariu cu mai multe linii în cadrul codului pe care doriți să faceți comentariu, noul comentariu va ajunge în același loc cu primul comentariu.

Utilizați comentariile pentru a crea o documentație simplă. Puteți utiliza formatul de creatie pentru a permite ca documentația să fie făcută direct în cod. Acest lucru poate fi util pentru proiecte open source.

sfaturi

Comentariile în HTML și PHP sunt diferite. Deci, atunci când folosiți script-uri (amestecând HTML cu PHP), aveți grijă să nu faceți schimb de comentarii.
În codul de mai jos, de exemplu, există un comentariu HTML, dar codul PHP va fi încă executat. Punerea unui comentariu HTML în interiorul etichetelor PHP va cauza erori.