How do I comment my HTML, CSS, JavaScript, and PHP code?

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

HTML comments are specifically designed to comment out code when you are in an HTML coded document. Below is the syntax for HTML comments.

HTML comment

<!-- <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>

CSS, JavaScript, and PHP Comments

CSS comments are done in the CSS .css stylesheet or in the Internal Style sheet. JavaScript comments can be placed inside HTML documents or in a .js file where JavaScript is ran. PHP code will be in .php files between <?php and ?> code. The following code shows the syntax for commenting out CSS, JavaScript, and PHP code.

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

An Example of a usage of this is shown in the following code. Below is showing PHP code; however, you use the same process to comment JavaScript and CSS.

<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>

Thoughts on “How do I comment my HTML, CSS, JavaScript, and PHP code?

Leave a Reply