Komment, megjegyzés hozzáfűzése PHP kódhoz

Az egyik legalapvetőbb és legfontosabb dokumentációs eszköz a kommentelés, melynek segítségével programkódunkat megjegyzésekkel egészíthetjük ki. Ebben a cikkben azt mutatjuk be, hogy hogyan fűzhetünk megjegyzéseket a PHP kódunkhoz.

A PHP leckékhez készített kép, mely bemutatja, hogy weboldalunkon ingyenesen tanulható a PHP nyelv

Komment, megjegyzés hozzáfűzése PHP kódhoz

Az egyik legalapvetőbb és legfontosabb dokumentációs eszköz a kommentelés, melynek segítségével programkódunkat megjegyzésekkel egészíthetjük ki. Ebben a cikkben azt mutatjuk be, hogy hogyan fűzhetünk megjegyzéseket a PHP kódunkhoz.

Miért kommenteljük a PHP kódunkat?

A PHP kódunkhoz fűzött komment nem csak nekünk segít később emlékezni arra, hogy mit miért csináltunk, hanem abban az esetben is nagy segítséget nyújt, amikor egy PHP program fejlesztését másnak adjuk át. Hiszen, ha az új webfejlesztőnek csak arra kellene alapoznia, hogy mit tud kivenni az általunk írt kódból, akkor a programkód megértése is óriási erőforrásokat emésztene fel. Ilyenkor nyújt óriási segítséget a kódhoz fűzött komment, mert azzal tűpontosan tudjuk dokumentálni, hogy melyik sor mit csinál.

Illetve olyan esetekben is szoktuk használni, amikor egy kódrészletet csak ideiglenesen szeretnénk eltávolítani a kódból, ilyenkor nem szükséges a kódot teljesen törölni, elegendő csak kikommentelni azt.

Hogyan kommenteljünk PHP-ban?

A JavaScript-hez képest a megszokottakon túl, itt lesz még egy lehetőségünk a megjegyzések írásához.

Szintaxis #1:

// egysoros komment
Code language: JSON / JSON with Comments (json)

Használhatjuk a jól megszokott “//” jeleket is az egysoros kommentek írásához.

Példa #1:

PHP kód

<!DOCTYPE html>
  <html>
    <body>
      <?php
        // ez egy egysoros komment, ami nem látszik a weboldalon
        echo "Ez látszani fog a böngészőben.";
      ?>
    </body>
  </html>
Code language: HTML, XML (xml)

Eredmény

Ez látszani fog a böngészőben.



Szintaxis #2:

# egysoros komment
Code language: PHP (php)

De a PHP-ban lehetőségünk van az egysoros kommenteket “#” jellel is megjelölni. A működésben és megjelenésben semmi sem változik.

Példa #2:

PHP kód

<!DOCTYPE html>
  <html>
    <body>
      <?php
        # ez egy egysoros komment, ami nem látszik a weboldalon
        echo "Ez látszani fog a böngészőben.";
      ?>
    </body>
  </html>
Code language: HTML, XML (xml)

Eredmény

Ez látszani fog a böngészőben.




Szintaxis #3:

/*
többsoros
komment
*/
Code language: JSON / JSON with Comments (json)

A többsoros megjegyzések létrehozása is a megszokott módon történik.

Példa #3:

PHP kód

<!DOCTYPE html>
  <html>
    <body>
      <?php
        /*
        többsoros
        komment
        */
        echo "Ez látszani fog a böngészőben.";
      ?>
    </body>
  </html>
Code language: HTML, XML (xml)

Eredmény

Ez látszani fog a böngészőben.

Ha hasznos volt számodra, akkor kérlek oszd meg másokkal is, hogy ezzel támogass minket!