1
Utilizați comentariile pentru a lăsa note despre modul în care funcționează codul. Nu ar trebui să faceți acest lucru pentru fiecare linie de cod, deoarece codul bun ar trebui să fie destul de ușor de analizat din alte programe. Este util dacă codul se comportă anormal sau, evident, nu funcționează.
// generează curl request $ session = curl_init ($ request) - // spune curl să folosească HTTP POSTcurl_setopt ($ session, CURLOPT_POST, true) -
2
Lăsați comentarii astfel încât să vă amintiți ce ați făcut. Dacă lucrați la propriile proiecte, comentariile vă pot ajuta să vă amintiți unde ați rămas. Lăsați comentarii despre codul care nu funcționează corect sau pe care nu l-ați terminat încă.
// Înainte de a merge mai departe, ieșirea trebuie privită din nou Echo "Hello World!" -
3
Comentariți codul pe care doriți să-l distribuiți. Dacă doriți să lucrați cu alții sau să faceți codul dvs. open source, comentariile pot ajuta pe alții să afle cum funcționează codul dvs. și unde sunt cele mai bune locuri pentru îmbunătățire.
/ * Există o modalitate mai eficientă de a realiza acest lucru? * / Sex: Femeie Male
4
Utilizați comentariile pentru a împiedica executarea anumitor blocuri de cod. Acest lucru este util dacă testați ceva și trebuie să împiedicați includerea unei anumite bucăți de cod în listă. Totul între etichetele de comentariu este ignorat când pagina se încarcă.
5
Aveți grijă când comentați blocuri mari de cod. Funcția de comentariu se termină la atingerea primei etichete de sfârșit, deci dacă există deja un comentariu în mai multe rânduri în codul comentat, comentariul merge doar la sfârșitul comentariului original imbricat.
6
Utilizați comentariile pentru a crea o pseudo-documentație. Puteți utiliza formatul de cod creativ pentru a crea documentația pentru codul dvs. direct în cod. Acest lucru poate fi util pentru proiecte open source.