Kuidas lisada oma PHP programmile kommentaare


Igal programmeerijal on oma arvamus selle kohta, milline teave tuleks programmikoodi lisada. Enamik programmeerijaid lisab oma koodiga märkusi, et endale ja kellelegi teisele meelde tuletada, mida kood teeb ja kuidas ta seda teeb. Kui otsustatakse, millist teavet lisada, küsige endalt, mida oleks teil vaja programmi kohta öelda, kui keegi teine ​​oleks programmi kirjutanud ja nüüd palutakse teil seda käivitada ja hooldada.

Enamikul teie kirjutatud programmidest on rohkem kui üks koodileht. Iga koodileht salvestatakse PHP-programmifailina. (failinimi.php3) Programmifailis on kaks kohta, kuhu soovite lisada mõned informatiivsed kommentaarid.

  1. Iga programmifaili ülaosas on üldine teave programmi kohta.

    • Faili ülaossa ja kohe pärast PHP-sildi avamist paned faili nime, näiteks HelloWorld.php3.
    • Järgmisena lisate autoriõiguse teatise, nimetades ennast programmi autoriõiguse omanikuks.
    • Kui teie programmis on rohkem kui üks koodileht, mainite, et see on suurema programmi üks leht, ja pange selle programmi nimi.
    • Samuti soovite lisada programmi eesmärgi ja toimimise lühikirjelduse.
    • Viimaseks lisate mis tahes lahtiütluse ja litsentsimisteabe. Näiteks võib see olla teie juristi kirjutatud litsents või GNU üldine avalik litsents, mida saate oma vabavaralise programmiga vabalt kasutada. Selle litsentsi koopia saate alla laadida Free Software Foundationi veebisaidilt. Me arutame seda üksikasjalikumalt eraldi õpetuses.

  2. Teine ala, kuhu soovite kommentaare lisada, on kogu kood kood iga suurema jaotise alguses. Lisage lühike kommentaar selle kohta, millist ülesannet see konkreetne osa täidab.
Programmi koodile kommentaaride lisamiseks on kolm viisi.

// kommentaarid lähevad siia
See on PHP-stiili põhikommentaar. Kõik samal real ja pärast kahte // tulevat serverit ignoreeritakse ja neid ei töödelda programmikoodina.

# kommentaari lähevad siia
See on kest-stiilis kommentaar. Serveri poolt ignoreeritakse kõike samal real ja pärast # asuvat ning neid ei töödelda programmikoodina.

/*
kommentaarid lähevad siia
kommentaarid lähevad siia
kommentaarid lähevad siia
*/
See on C-stiilis kommentaar. Kõik, mis jääb avamise / * ja sulgemise * / vahele, ignoreerib server ja neid ei töödelda programmikoodina. Seda stiili saate kasutada siis, kui teil on rohkem kui üks rida kommentaare, nagu oleme selles õpetuses arutanud. Näite saamiseks klõpsake siin.




PHP for Web Development (Oktoober 2021)



Silte Artikkel: Kuidas lisada oma PHP programmile kommentaare, PHP, PHP, dünaamilised veebilehed, veebiskriptide keeled, php, relatsiooniandmebaasid, MySQL, PHP versioon 4, php programmeerimine, php õpetused, php artiklid, php ressursid, Apache, lähtekood, veebiarendus , Veebimeistrid, teatmik, näpunäited, rakendused, php-põhitõed, php-sildid, muutujad, operaatorid

Enim Ilu Postitused

Kajaka raamatu ülevaade
raamatud ja muusika

Kajaka raamatu ülevaade

Providence'i lastemuuseum
reisimine ja kultuur

Providence'i lastemuuseum

Teevõileivad

Teevõileivad

toit ja vein

kehakunst 124

kehakunst 124

ilu ja mina