Cum să comentați în PHP

Un comentariu este un tip de adnotare care poate fi folosit pentru a clarifica scopul sau intenția unui segment de cod. Când utilizați PHP aveți mai multe opțiuni de alegere, care sunt derivate din vechile limbi populare, care au avut două alternative pentru a face comentarii pe o singură linie și, de asemenea, comentarii pe mai multe linii în stil C. Puteți utiliza comentariile pentru a împiedica rularea anumitor părți din cod sau chiar să le folosească pentru a crea documentație.

pași

2

Utilizați comentarii cu mai multe linii pentru a scrie comentarii lungi sau pentru a testa codul. Comentariile din mai multe linii sunt utile pentru scrierea unor explicații lungi sau pentru evitarea prelucrării unui segment de cod. Citiți secțiunea "aplicații" de mai jos pentru a vedea câteva sfaturi cu privire la diferitele utilizări ale comentariilor din mai multe linii.

// Generați solicitarea CURL $ session = curl_init ($ request) - // Spuneți CURL-ului pentru a utiliza HTTP POSTcurl_setopt ($ session, CURLOPT_POST, true) -

2

Lăsați comentariile să vă amintiți ce faceți. De fiecare dată când lucrați la propriile proiecte, puteți folosi comentariile pentru a vă ajuta să vă amintiți unde ați lăsat-o. Lăsați comentarii despre părți ale codului care nu funcționează corect sau că nu ați terminat încă.

// Este necesar să verificați ieșirea înainte de a merge direct "Bună ziua!"-

3

Adăugați comentarii în codul pe care urmează să-l distribuiți. Dacă intenționați să colaborați cu alte persoane sau intenționați să creați surse deschise, comentariile pot ajuta pe alții să descopere modul în care funcționează codul dvs. și care sunt cele mai bune locuri pentru îmbunătățirea acestuia.

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

4

Utilizați comentariile pentru a împiedica apariția blocurilor de coduri specifice. Acest lucru este util dacă încercați ceva și trebuie să evitați să executați o anumită parte a codului. Totul din interiorul etichetelor de comentariu va fi ignorat atunci când pagina se încarcă.

5

Fiți atent atunci când discutați blocuri mari de cod. Funcția de comentare se va termina la găsirea primei etichete de închidere, deci dacă există deja un comentariu al mai multor rânduri din codul pe care l-ați comentat, comentariul va ajunge doar la sfârșitul primului comentariu imbricat.

6

Utilizați comentariile pentru a crea o pseudocumentație. Puteți utiliza un format de cod de reclamă pentru a crea documentație în codul dvs. și pentru codul dvs. Acest lucru poate fi util în proiecte de dezvoltare open source.