Table of Contents
What is HTML Comment
HTML comments are used to add notes or explanations to an HTML document that are not visible to website visitors. Comments are written in plain text and are used to provide instructions, describe the purpose of certain code, or to remind the website developer about something important.
HTML comments start with <!-- and end with -->. Anything between these two symbols will not be displayed on the website. For example:
<!DOCTYPE html>
<html>
<body>
<h2>The second paragraph will not be shown in the browser</h2>
<p>This is first paragraph</p>
<!-- <p> This is second paragraph</p> -->
<p>This is third paragraph</p>
</body>
</html>HTML Comments for Hiding Sections
HTML comments are also used to temporarily remove sections of code from a web page without deleting them. This can be useful for testing, debugging or troubleshooting a web page.
<!DOCTYPE html>
<html>
<body>
<h2>The second paragraph will not be shown in the browser</h2>
<p>This is first paragraph</p>
<!-- <p> This is second paragraph</p> -->
<p>This is third paragraph</p>
</body>
</html>HTML Comments for Code Instructions/Documentation
HTML comments can be used as code instructions to provide guidance to other developers who may be working on the same codebase.
For example, if you have a complex piece of HTML code, you can add comments to explain the purpose of different sections. This can make it easier for other developers to understand what the code does and how it works.
<!DOCTYPE html>
<html>
<body>
<!--visible-start-->
<!-- This section contains the header of the page -->
<header>
<h1>Welcome to my website</h1>
</header>
<!-- This section contains the main content of the page -->
<main>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
</main>
<!-- This section contains the footer of the page -->
<footer>
<p>Copyright © 2023</p>
</footer>
<!--visible-end-->
</body>
</html>