How to Comment in PHP

PDF download Download Article
PDF download Download Article

A comment is a type of annotation that can be used to clarify the purpose and intent of a piece of code. When using PHP, you have several options to choose from that stem from popular older languages with two choices of single line comments and also a multi-line C-style comment. You can use comments to keep sections of code from running, and can even use them to create documentation.

Part 1
Part 1 of 2:

Styles

PDF download Download Article
  1. If you need to leave a short comment, you can use the single-line comment code. The comment will only last to the end of the line or the end of the code block. These comments only work within PHP tags, and will be read if placed in HTML. [1] 
      
 <?php 
 // This is the standard (C++) way to create a single-line comment 
 # You can also use this Unix style to create a single-line comment 
 ?>
  2. Multi-line comments are useful for writing a long explanation, or for preventing a segment of code from being processed. See the "Usage" section below for some tips on using multi-line comments. [2] 
      
 <?php 
 /* This is how you format 
 a multi-line comment. Everything 
 until the ending tag will be included 
 in the comment */ 
 /* Some people like to include 
 * extra markers at the beginning 
 * of each line. This can help with readability 
 * for large comments, but isn't necessary. 
 */ 
 ?>
    3. Advertisement
Part 2
Part 2 of 2:

Usage

PDF download Download Article
  1. You shouldn't have to do this for every line of code, since good code should be fairly easy to parse by other programmers. It is useful if the code is performing irregular or not obvious functions. [3] 
     // Generate curl request 
 $session 
 = 
 curl_init 
 ( 
 $request 
 ); 
 // Tell curl to use HTTP POST 
 curl_setopt 
 ( 
 $session 
 , 
 CURLOPT_POST 
 , 
 true 
 );
  2. Whenever you're working on your own projects, comments can help you remember where you left off. Leave comments on code that isn't working properly, or that you haven't finished yet. 
     // Need to revisit the output for this before moving on 
 echo 
 "Hello World!" 
 ;
  3. If you plan on collaborating with others, or intend to make your code open-source, comments can help others figure out how your code functions and the best places to make improvements. [4] 
     /* Is there a more effective way to accomplish this? */ 
 Gender: 
 <input type="radio" name="gender" 
 <?php 
 if 
 ( 
 isset 
 ( 
 $gender 
 ) 
 && 
 $gender 
 == 
 "female" 
 ) 
 echo 
 "checked" 
 ; 
 ?> 
  
 value="female">Female 
 <input type="radio" name="gender" 
 <?php 
 if 
 ( 
 isset 
 ( 
 $gender 
 ) 
 && 
 $gender 
 == 
 "male" 
 ) 
 echo 
 "checked" 
 ; 
 ?> 
  
 value="male">Male
  4. This is useful if you're testing something and need to prevent certain code from being run. Anything contained within the comment tags will be ignored when the page is loaded. 
      
 <?php 
 echo 
 "/*Hello*/ World!" 
 ; 
 /* The word "Hello" will not be displayed 
 when the above code is run */ 
 ?>
  5. The comment function will end whenever the first ending tag is hit, so if there's already a multi-line comment inside the code you comment out, the comment will only last until the end of the original nested comment. 
      
 <?php 
 /* 
 echo "Hello World!"; /* This comment will mess things up */ 
 */ 
 ?> 
  



      
 <?php 
 /* 
 echo "Hello World!"; // This comment will be fine 
 */ 
 ?>
  6. You can use some creative code formatting to create documentation for your code directly in the code. This can be useful for open-source projects. 
      
 <?php 
 //============= 
 // HEADING 
 //============= 
 //------------- 
 // Sub-Heading 
 //------------- 
 /* Title Of Section */ 
 # Documentation can go here 
 # A second piece can go here 
 /* 
 * Use these for explaining something 
 * that would take several lines or 
 * even multiple paragraphs to explain 
 */ 
 ?>
    7. Advertisement

Expert Q&A

Ask a Question
200 characters left
Include your email address to get a message when this question is answered.
Submit
      Advertisement

      Tips

      • HTML comments and PHP comments are both different, so when you are using scripting (HTML and PHP mix), take care that you aren't mixing comments.
        Thanks
        Helpful 0 Not Helpful 0
      • For example, in the below code, there is an HTML comment, but it still executes PHP code. Placing an HTML comment within PHP tags will cause errors.
        • <!--<div id="example"><?php echo 'hello'; ?></div>-->
        Thanks
        Helpful 0 Not Helpful 0
      Submit a Tip
      All tip submissions are carefully reviewed before being published
      Name
      Please provide your name and last initial
      Submit
      Thanks for submitting a tip for review!
      Advertisement

      You Might Also Like

      3 Ways to See Which PHP is Installed + Troubleshooting
      How Do You Open PHP Files?
      How to
      Make a Raspberry Pi Web Server
      How to
      Learn Web Design
      Advertisement

      Expert Interview

      Thanks for reading our article! If you’d like to learn more about programming, check out our in-depth interview with Tyrone Showers .

      References

      1. ↑ http://www.w3schools.com/php/php_syntax.asp
      2. ↑ http://php.net/manual/en/language.basic-syntax.comments.php
      3. ↑ https://sendgrid.com/docs/Integrate/Code_Examples/php.html
      4. ↑ http://www.w3schools.com/php/php_form_complete.asp

      About This Article

      Article Summary X

      1. Place // at the beginning of the line for a single-line comment.
      2. Place /* at the beginning of a multi-line comment, and */ at the end.

      Did this summary help you?
      In other languages
      Thanks to all authors for creating a page that has been read 66,547 times.

      Is this article up to date?

      Advertisement