Az összetettebb, hosszabb PHP-kódokat érdemes olyan információkkal kiegészíteni, amelyek a jövőben is segítségünkre lehetnek a sorok értelmezésében. A PHP lehetőséget ad arra, hogy a kód értelmezését könnyítő megjegyzéseket, azaz kommentárokat szúrjunk be a PHP-kód soraiba.
A PHP-megjegyzések vagy -kommentárok nagyon hasonlóak azokhoz, amelyeket a HTML-ben is használunk — ezekkel már korábban is találkozhattál, ha figyelemmel kísérted cikksorozatunkat. A PHP-kommentár mindig speciális karaktersorozattal kezdődik, és minden olyan szöveg, amely a megjegyzés kezdete és vége között van, ignorálva lesz.
A HTML-ben a megjegyzések fő célja, hogy emlékeztető jegyzetként segítsenek a fejlesztőnek vagy bárkinek, aki később a weboldal forráskódjával foglalkozik. A PHP esetében azonban ezek a megjegyzések a látogatók számára láthatatlanok. Az egyetlen mód arra, hogy a megjegyzéseket láthatóvá tegyük, hogy megnyitjuk a PHP-fájlt egy szerkesztőben. Éppen ezért a PHP-megjegyzések csak a programozók számára hasznosak.
Amellett, hogy a kommentárba írt jegyzetek hasznosak lehetnek a későbbi munkánk során, a megjegyzések segítségével a program írása közben „deaktiválhatunk” bizonyos részeket a programból, anélkül, hogy kitörölnénk őket (hátha később még szükségünk lesz rájuk). Ez tesztelés vagy debuggolás során különösen hasznos.
Idézzük fel, milyen is egy megjegyzés a HTML-ben:
<!-- Ez egy HTML-megjegyzés -->
PHP-megjegyzés szintaxis: egysoros megjegyzés
A HTML-ben a megjegyzéseknek egyetlen fajtája van, a PHP-ben azonban kétféle kommentárral is találkozhatunk. Az első típus, melyre kitérünk, az egysoros megjegyzés. Ez arra utasítja az értelmezőt (interpretátort), hogy ignoráljon mindent a sorban, ami a kommentár jelölésének jobb oldalán található. Az egysoros megjegyzéseket a // vagy # jelöléssel tudjuk megkezdeni. Az összes szöveg, mely egy sorban, a jelölés jobb oldalán (a jelölés után) található, ignorálva lesz a PHP-értelmező részéről. Az egysoros megjegyzéseket nem kell bezárni, hiszen ezek a sor végéig vagy a PHP-blokk végéig érvényesek — amelyik előbb van.
Nézzünk egy példát:
Az eredmény, mely a böngészőben látható:
Érdemes megfigyelni, hogy néhány echo állítás sem lett megjelenítve, mert „deaktiváltuk” őket egy egysoros megjegyzéssel. Mint említettük, ez a módszer különösen hasznos, ha gyorsan szeretnénk eltüntetni egy komplex PHP-kód egy sorát, anélkül, hogy végleg kitörölnénk.
PHP-megjegyzés szintaxis: többsoros megjegyzés
A HTML-megjegyzésekhez hasonlóan a PHP-megjegyzésekkel is „kikommentálhatjuk” a kód nagyobb részeit, de többsoros megjegyzéseket is írhatunk magunknak. A többsoros PHP-megjegyzések a /* jelöléssel kezdődnek, és a */ jelöléssel kell őket bezárni.
Lássunk egy példát erre is:
Az eredmény, mely a böngészőben látható:
Helló Világ!
A többsoros kommentároknál oda kell figyelni arra, hogy ne helyezzük őket egymásba. Ez gyakori hiba, mikor a kód egy nagy blokkját szeretnénk kommentárrá tenni. Mutatunk erre is egy példát:
Néhány jótanács:
Egy tipp, melyet egy kezdő PHP-programozónak adnánk a megjegyzéseket illetően: használd őket!
Sokan esnek abba a hibába, hogy komplex PHP-kódokat írnak, és vagy túl lusták ahhoz, hogy jó megjegyzéseket írjanak hozzájuk, vagy abban a hitben élnek, hogy a megjegyzések feleslegesek. Ez azonban nagy hiba, hiszen néhány év múlva ki emlékezne arra, mi járt a fejében, amikor a kódot írta. Főleg, hogy időközben valószínűleg számos más kódot is írt.
Használd a megjegyzéseket, és a jövőbeli éned hálás lesz érte! Az egysoros megjegyzésekkel rövid jegyzeteket fűzhetsz a kód egy-egy bonyolultabb részletéhez, a többsoros megjegyzésekkel pedig részletesebben is le tudod írni egy-egy kódrészlet működését.
Amint az a cikkből kiderült, a megjegyzések számos formában és méretben igénybe vehetőek, a felhasználási módjuk pedig a programozótól függ. Ha azonban igyekszel mindig egyformán kommentálni, azzal megkönnyítheted a saját dolgodat is, és annak a személynek a munkáját is, aki esetleg utánad fog dolgozni a kódon.
Összegzés:
Mai leckénk a könnyebbek közé tartozott — ezt valószínűleg te is így érezted, hiszen a megjegyzések már ismerősek a HTML világából is, de a PHP-sorozatunkban is már említettük őket. Ma részletesebben is megismerkedhettél velük, és fenti tanácsunkat csak ismételni tudjuk: használj megjegyzéseket a kódjaidban! A jövő héten ismét komolyabb témákkal fogunk foglalkozni: bemutatjuk az include parancsot — addig is jó gyakorlást!
NYEREMÉNYJÁTÉK!
Rovatunk elsődleges célja, hogy közelebbről is bemutassa a legismertebb webtechnológiákat. Azok között az olvasók között, akik minden héten követik rovatunkat, azaz velünk tanulják a programozás alapjait és kitöltik a feladatsort, a sorozat végén egy laptopot sorsolunk ki.
A játék heti kérdése:
Milyen jelöléssel kezdődnek a többsoros PHP-megjegyzések?
A választ a tanulok@erdsoft.com e-mail-címre kell elküldeni, a tárgysorba pedig
a következőt kell beírni: HÉTNAP-TANULOK. Sok szerencsét!
Néhány szó rólunk:
Az ErdSoft (www.erdsoft.com) 2011-ben alakult meg. Csapatunkat a fiatalos lendület, a szakértelem, a folyamatos tanulás és tapasztalatgyűjtés jellemzi. Ügyfeleinknek igyekszünk teljes körű szolgáltatást nyújtani — bátran fordulhatnak hozzánk, legyen szó webfejlesztésről, alkalmazásokról, SEO-optimalizálásról, grafikai tervezésről, marketingről vagy szövegírásról. Csapatunk sikerét mi sem bizonyítja jobban, mint a több száz elkészült weboldal és a számos elégedett ügyfél Szerbiában, Magyarországon és az Egyesült Királyságban.
