Commentaar in vier stijlen
In PHP-scripts kun je commentaar toevoegen in verschillende stijlen. Voor één regel commentaar kan je het hekje (#) of dubbel slash (//) gebruiken. Deze stijlen zijn niet van PHP zelf. Ze komen uit andere computertalen, zo komt // uit C++ en # uit Perl. Deze twee zijn single-line, dus één regel. Het is gebruikelijk commentaar toe te voegen boven de regel waarop stukje code wordt uitgevoerd, bijvoorbeeld:
Code (php)
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
<?php
// Btw-bedrag berekenen met 19%
$btw_bedrag = 0.19 * $bedrag;
// Btw-bedrag afronden op 2 decimalen
$btw_bedrag = round($btw_bedrag, 2);
// Totaal inclusief btw berekenen
$bedrag = $bedrag + $btw_bedrag;
?>
// Btw-bedrag berekenen met 19%
$btw_bedrag = 0.19 * $bedrag;
// Btw-bedrag afronden op 2 decimalen
$btw_bedrag = round($btw_bedrag, 2);
// Totaal inclusief btw berekenen
$bedrag = $bedrag + $btw_bedrag;
?>
De PHP-parser negeert whitespace. Voor commentaar geldt een uitzondering. Alles vanaf // of # wordt tot het einde van de regel wordt behandeld als commentaar. Als commentaar kort is, wordt het meestal toegevoegd aan het einde van de regel, bijvoorbeeld:
Code (php)
1
2
3
4
5
2
3
4
5
<?php
$btw_bedrag = 0.19 * $bedrag //; 19% btw (omzetbelasting)
$btw_bedrag = round($btw_bedrag, 2); // Btw afronden op centen
$bedrag = $bedrag + $btw_bedrag;
?>
$btw_bedrag = 0.19 * $bedrag //; 19% btw (omzetbelasting)
$btw_bedrag = round($btw_bedrag, 2); // Btw afronden op centen
$bedrag = $bedrag + $btw_bedrag;
?>
Wil je langere blokken commentaar maken, dan is het mogelijk om ze binnen /* ... */ te zetten in de stijl van C en CSS. Als je dat doet, worden regeleinden wel genegeerd en moet je het commentaar met */ afsluiten. Dit heet dan ook multi-line, omdat het op meerdere regels kan staan. Dit kan duidelijker zijn. Als je bijvoorbeeld bovenstaande code met deze stijl doet, kan je het zo doen:
Code (php)
1
2
3
4
5
6
2
3
4
5
6
<?php
/* Het btw-bedrag berekenen met 19% btw, het btw-bedrag afronden op centen en tot slot het hele bedrag berekenen */
$btw_bedrag = 0.19 * $bedrag;
$btw_bedrag = round($btw_bedrag, 2);
$bedrag = $bedrag + $btw_bedrag;
?>
/* Het btw-bedrag berekenen met 19% btw, het btw-bedrag afronden op centen en tot slot het hele bedrag berekenen */
$btw_bedrag = 0.19 * $bedrag;
$btw_bedrag = round($btw_bedrag, 2);
$bedrag = $bedrag + $btw_bedrag;
?>
Er bestaat geen verschil tussen /* en /** met een extra sterretje. Maar als je het commentaar opent met /**, dan wordt het wel overgenomen door phpDocumenter, waarover later meer.
« vorige pagina | volgende pagina »