Hur man kommenterar PHP

 

Vad är en kommentar?

Man kan beskriva en kommentar som en dokumentation som är inbyggd i php-scriptet.

För att se kommentarer som ligger i php-scriptet så måste man öppna filen för redigering, dessa syns alltså inte när man kör scriptet då PHP-motorn tar bort alla kommentarer innan det skickas till mottagarens webbläsare.

Varför?

Om man t.ex. håller på med ett php-projekt under en längre tid så är det alltid bra att har kommenterat koden för att man snabbt ska få information om vad just detta kodstycke gör utan att på nytt behöva tolka koden för att ta reda på det.

Om du tar för vana att alltid kommentera din kod, så har du stor nytta av detta i framtiden om du ska in och ändra på något, för du tror väll inte att du kommer ihåg exakt hur du tänkte när du tittar på skriptet om ett år eller mer.

Det är även viktigt att man kommenterar koden om det är flera personer som tillsammans arbetar med projektet, det är ju inte alltid så enkelt att tolka någon annans kod då varje person ofta sätter sin egen prägel på koden (det finns alltid mer än ett sätt att lösa en uppgift).

Hur?

En kommentar börjar alltid med en kombination av tecken beroende av vilken typ av kommentar det gäller.

Syntax för kommentar i HTML:

För att kommentera kod som ligger utanför php-taggarna så måste man använda den syntax som HTML använder för att kommentaren inte ska visas i webbläsaren

<!–   Detta är en HTML kommentar   –>

Syntax för kommentar i PHP:

När det gäller kommentarer i php så kan man dela upp dessa i två typer, enkel-radig kommentar och fler-radig kommentar.

En enkel-radig kommentar börjar med “ // “ eller “ # “ och kan ligga på en egen rad eller i slutet på en kodrad.

PHP-kod:

<?php

echo "Hej Världen!"; // Detta kommer att skriva Hej Världen på skärmen

echo "<br />Du kan inte se kommentarer i webbläsaren!"; // echo "en kommentar";

// echo "Jag heter Kalle Kula!";

# echo "Denna kommentar syns inte";

?>

Detta visas:

Hej Världen!

Du kan inte se kommentarer i webbläsaren!

Fler-radiga kommentarer börjar med “ /* “ och slutar med “ */ ”, denna typ av kommentar är väldigt bra att använda om du tillfälligt vill avaktivera ett kod-stycke t.ex. i felsökningssyfte.

PHP-kod:

<?php

/* Detta echo-kommando kommer att skriva ut

den text som jag vill förmedla till världen */

echo “Hej världen”;

/* echo “jag heter Kalle Kulla”;

echo “skojjade bara, ja heter ju något annat”;

*/

Detta visas:

Hej Världen!

 

 

>> PHP-Skolan

Recent Entries

Kommentera