PHP Programming/formatting notes
 |
A Wikibookian suggests that this book or chapter be merged with PHP Programming/Commenting and Style. Please discuss whether or not this merger should happen on the discussion page. |
Commenting in PHP is simple and effective.
Writing notes to yourself, within your code, is the only way to keep track of a large file. Coming back to an uncommented 300-line page of code can be a nightmare.
To insert a single line comment within php code type // before the line. To insert a multi-line comment within code start the comment with /* and end it with */. For example:
<?php
$example = 1
//this is a comment that will be ignored. But will help me remember what the code means.
if (!randomfunction($_POST[dart])){function(example); $example ++;}
/*This is a long
multi-line comment that will
help me remember what the code means.
It will be ignored by the php-
parser*/
randomfuction($example);
?>