Comentariu în PHP

Un comentariu este un fel de adnotare care poate clarifica scopul și intenția unei bucăți de cod. Dacă utilizați PHP, aveți mai multe opțiuni de alegere - linia populară de limbă mai veche, cu două alternative pentru comentarii cu o singură linie și comentarii în mai multe rânduri în stil C. Puteți folosi comentariile pentru a împiedica executarea anumitor părți ale codului și chiar pentru a crea documentația cu ele.

metodă

Partea 1
stiluri

Imagine cu titlul 2165137 1
1
Utilizați comentariile dintr-o singură linie pentru comentarii scurte. Dacă trebuie să lăsați un scurt comentariu, puteți folosi codul de comentariu dintr-o singură linie. Comentariul se extinde numai la sfârșitul liniei sau al blocului de coduri. Aceste comentarii funcționează numai cu etichete PHP și sunt citite atunci când sunt puse în HTML.
  • Imaginea intitulată 2165137 2
    2
    Utilizați comentarii pentru mai multe linii pentru comentarii mai lungi sau pentru testarea codurilor. Comentariile cu mai multe linii sunt utile în scrierea unei explicații lungi sau pentru a împiedica prelucrarea unei părți a codului. Consultați secțiunea "Utilizare" de mai jos pentru sfaturi privind utilizarea comentariilor cu mai multe linii.
  • Partea 2
    utilizare

    Imagine cu titlul 2165137 3
    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) -
  • Image cu titlul 2165137 4
    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!" -


  • Imaginea intitulată 2165137 5
    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
  • Image cu denumirea 2165137 6
    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ă.
  • Imagine cu titlul 2165137 7
    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.
  • Imagine cu titlul 2165137 8
    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.
  • Sfaturi

    • Comentariile HTML și comentariile PHP sunt diferite, deci, dacă combinați scenariile împreună (HTML și PHP), aveți grijă să nu amestecați comentariile.
    • Codul de mai jos are de ex. un comentariu HTML, dar încă execută codul PHP. Publicarea unui comentariu HTML în etichetele PHP duce la erori.
    Distribuiți pe rețelele sociale:

    înrudit