Comments in PHP: Enhancing Code Readability and Maintenance
☰Fullscreen
Table of Content:
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:
<span class="pln"> </span><span class="dec"><!DOCTYPE html></span><span class="pln"> </span><span class="tag"><html></span><span class="pln"> </span><span class="tag"><body></span><span class="pln"> </span><span class="pun"><?</span><span class="pln">php </span><span class="com">// This is a single-line comment</span><span class="pln"> </span><span class="com"># This is also a single-line comment</span><span class="pln"> </span><span class="pun">?></span><span class="pln"> </span><span class="tag"></body></span><span class="pln"> </span><span class="tag"></html></span><span class="pln"> </span>
Syntax for multiple-line comments:
Syntax:
<span class="pln"> </span><span class="dec"><!DOCTYPE html></span><span class="pln"> </span><span class="tag"><html></span><span class="pln"> </span><span class="tag"><body></span><span class="pln"> </span><span class="pun"><?</span><span class="pln">php </span><span class="com">/* This is a multiple-lines comment block that spans over multiple lines */</span><span class="pln"> </span><span class="pun">?></span><span class="pln"> </span><span class="tag"></body></span><span class="pln"> </span><span class="tag"></html></span><span class="pln"> </span>
Using comments to leave out parts of the code:
Syntax:
<span class="pln"> </span><span class="dec"><!DOCTYPE html></span><span class="pln"> </span><span class="tag"><html></span><span class="pln"> </span><span class="tag"><body></span><span class="pln"> </span><span class="pun"><?</span><span class="pln">php </span><span class="com">// You can also use comments to leave out parts of a code line</span><span class="pln"> $p </span><span class="pun">=</span><span class="pln"> </span><span class="lit">10</span><span class="pln"> </span><span class="com">/* + 15 */</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> </span><span class="lit">12</span><span class="pun">;</span><span class="pln"> echo $p</span><span class="pun">;</span><span class="pln"> </span><span class="pun">?></span><span class="pln"> </span><span class="tag"></body></span><span class="pln"> </span><span class="tag"></html></span><span class="pln"> </span>
No Questions Data Available.
No Program Data.