Table of Contents

    Comments in PHP: Enhancing Code Readability and Maintenance

    Rumman Ansari July 09, 2024 6,357 views
    Comments in PHP: Enhancing Code Readability and Maintenance

    A comment in PHP code is a line that is not executed as a part of the program. Its only purpose is to be read by someone who is looking at the code.

    Comments can be used to:

    • Let others understand your code
    • Remind yourself of what you did - Most programmers have experienced coming back to their own work a year or two later and having to re-figure out what they did. Comments can remind you of what you were thinking when you wrote the code

    PHP supports several ways of commenting:

    Syntax for single-line comments:

    Syntax: 

    
<!DOCTYPE html>
<html>
<body>

<?php
// This is a single-line comment

# This is also a single-line comment
?>

</body>
</html>

    Syntax for multiple-line comments:

    Syntax: 

    
<!DOCTYPE html>
<html>
<body>

<?php
/*
This is a multiple-lines comment block
that spans over multiple
lines
*/
?>

</body>
</html>

    Using comments to leave out parts of the code:

    Syntax: 

    
<!DOCTYPE html>
<html>
<body>

<?php
// You can also use comments to leave out parts of a code line
$p = 10 /* + 15 */ + 12;
echo $p;
?>

</body>
</html>