Sisu

• Sammud
• Näpunäited

Kommentaar on märkuste tüüp, mida saab kasutada koodijupi eesmärgi selgitamiseks. PHP-s on saadaval mitu kommenteerimisvõimalust, millest kahte mõjutavad vanemad populaarsed keeled, kommenteerides ainult ühte rida. Teine võimaldab kommenteerida mitut rida korraga, nagu ka keeles C. Kommentaaride abil saate takistada koodijuppide käivitamist või isegi programmi dokumentatsiooni loomiseks.

Sammud

1. osa 2-st: Kommentaaride tüübid

1. 

   Lühikeste märkmete tegemiseks kasutage üherealisi kommentaare. Sellisel juhul lõpeb kommenteerimisala rea ​​lõpus või koodiploki lõpus. Need kommentaarid toimivad ainult sildid (markup) PHP, nii et neid saab lugeda ainult siis, kui need on paigutatud HTML-i.

2. 

   
   
   Suuremate koodijuppide kommenteerimiseks või testide tegemiseks kasutage mitmerealisi kommentaare. Seda tüüpi kommentaar on kasulik pika selgituse kirjutamiseks või koodisegmendi käivitamise takistamiseks. Sellist tüüpi kommentaaride kohta näpunäiteid leiate allpool jaotisest Rakendused.

2. osa 2: Rakendused

1. 

   Kasutage kommentaaride abil näpunäiteid koodi toimimise kohta. Kõigi ridade jaoks pole seda vaja teha, kuna hea kood peaks olema teistele programmeerijatele hõlpsasti arusaadav, kuid kommentaarid on väga kasulikud erinevate või raskesti mõistetavate funktsioonide selgitamiseks.

2. 

   
   
   Jätke kommentaare, et saaksite meenutada, mida olete varem teinud. Pole tähtis, kas töötate omaenda projekti kallal, kommentaarid aitavad teil meeles pidada, kus eelmine kord pooleli jäite. Jätke kommentaarid koodijuppide kohta, mis ei tööta või pole veel lõpetatud.

3. 

   Kommenteerige koode, mida soovite jagada. Kui plaanite teistega koostööd teha või plaanite teha avatud lähtekoodiga projekti, on kommentaarid väga kasulikud, et aidata teistel aru saada, kuidas kood töötab ja kuhu muudatusi teha.

4. 

   
   
   Konkreetsete koodiplokkide käivitamise vältimiseks kasutage kommentaare. See on väga kasulik testimiseks, kus vajate mõnda koodi, mida mitte käivitada. Lehe laadimisel eiratakse kõike siltide sees olevat.

5. 

   Olge suurte koodiplokkide kommenteerimisel ettevaatlik. Kommenteerimisfunktsioon lõpeb kohe, kui viimane silt on leitud, nii et kui koodis, mida kavatsete kommenteerida, on juba mitmerealine kommentaar, lõpeb uus kommentaar esimesega samas kohas.

6. 

   Kommentaaride abil saate luua lihtsat dokumentatsiooni. Võite kasutada loovvormingut, et võimaldada dokumentatsiooni otse koodis teha. See võib olla avatud lähtekoodiga projektide jaoks kasulik.

Näpunäited

• HTML ja PHP kommentaarid on erinevad. Seetõttu olge skriptide kasutamisel (HTML-i segamine PHP-ga) ettevaatlik ja ärge vahetage kommentaare.
• Näiteks allolevas koodis on HTML-i kommentaar, kuid siiski käivitatakse PHP-kood. HTML-i kommentaari paigutamine PHP-siltide sisse põhjustab vigu.
  • echo ’olá’;->