📖 INDEX
LOADING ENGINE...
HTML <!-- --> Comments
The standard way to leave notes and document your HTML code.
What are HTML Comments?
An HTML comment is a piece of text within an HTML document that is ignored by the browser. This means it is not displayed on the web page. Comments are used to leave notes for yourself or other developers, explain complex parts of the code, or temporarily disable sections of HTML without deleting them.
Syntax
The syntax for an HTML comment is simple. It starts with `<!--` and ends with `-->`.
<!-- This is a single-line comment. --><!-- This is a multi-line comment. -->Practical Examples
Code:
<p>This is a visible paragraph.</p>Result:
This is a visible paragraph.
Code:
<p>The following paragraph is commented out:</p>
Result:
The following paragraph is commented out:
Code:
<nav>
<a href="#">Home</a> | <a href="#">About</a>
</nav>
Result:
Best Practices
- Be Clear and Concise: Write comments that are easy to understand but don't state the obvious.
- Document Complex Code: Use comments to explain why a particular piece of code is written a certain way, especially if it's complex or has a non-obvious purpose.
- Don't Overuse: Clean, well-structured code is often self-documenting. Avoid cluttering your HTML with unnecessary comments.
- Security Warning: Never put sensitive information (like passwords or private data) in HTML comments. They are not displayed on the page, but they are still visible to anyone who views the page source.
Browser Compatibility
HTML comments are a fundamental part of the language and are universally supported by all web browsers without exception.
- ✔️ All Browsers (Chrome, Firefox, Safari, Edge, etc.)