When you are designing your website, there are many instances that require you to comment out code in your website. Commenting code is good for diagnosing website problems, hiding code instead of deleting the code, placing notes in a file to explain what was done, and many more reasons. This article will explain the basics of commenting code in your website files.
HTML comments are specifically designed to comment out code when you are in an HTML coded document. Below is the syntax for HTML comments.
<!-- <code to be commented out> -->
Example of an HTML comment
An Example of a usage of this is shown in the following code.
<html><head> <title>Document</title> </head><body> <!-- This is a comment --> <p>A paragraph in your site</p> <!-- This is code commented out <h1>Commented Title</h1> <p>A paragraph that is commented out.</p> --> </body></html>
Single Line comment
// <code to be commented out>
Multiple Line comment
/* <code to be commented out> <Other code to be commented out> <Some more code to be commented out> */
Example of PHP comment
<html><body> <?php // This is a comment on one line echo '<p>HTML code echoed by PHP.</p>'; /* This is code commented out echo '<h1>An HTML Title from PHP</h1>'; echo '<p>HTML code echoed by PHP.</p>'; */ ?> </body></html>