1 min Devops

How to: Basis PHP

Commentaar

Om je script overzichtelijk te houden, kan je soms beter wat commentaar toevoegen. Deze regels zullen genegeerd worden door PHP. Maar voor jezelf of voor anderen die de broncode moeten veranderen is het makkelijker erg handig.

Ik ga twee manieren uitleggen om commentaar toe te voegen in PHP:

Eén manier is om met // te werken. Daarvan zie je hieronder een voorbeeld. Deze is het makkelijkst om korte regels commentaar te laten zien. Dus kan je deze misschien het beste midden in scripts zetten.

PHP Code
1
2
3
4
5
6
 
<?php
// Korte regel commentaar
echo ‘test’;
?>
 

een situatie waarin je het kan gebruiken:

PHP Code
1
2
3
4
5
 
<?php
echo 'Blabla'; // geef blabla weer
?>
 


Een volgende manier is beter geschikt als je meerdere regels commentaar wil toevoegen aan je script.

PHP Code
1
2
3
4
5
6
7
8
 
<?php
/*
    Grote commentaar dit
    Nog meer commentaar!
*/
?>
 

Die manier zoals hierboven (/* en */) gebruik je als je grote stukken commentaar nodig hebt. Bijvoorbeeld om bovenaan het script een copyright melding weg te zetten en een bestandsnaam bijvoorbeeld. Of om in een aantal regels uit te leggen wat een bepaald stuk code doet.