跳到主要内容

HTML 注释

在编写 HTML 页面时，你可能需要添加一些说明性文字来解释代码的作用、提醒自己或其他开发者未来维护时该注意什么。这时，你就可以使用 HTML 的注释（comment）语法来实现。HTML 注释不会被浏览器渲染到页面上，因此用户是看不到这些内容的，它们只会在源码中出现。

HTML 注释语法​

HTML 注释的基本语法是这样的：

<!-- 这是一个注释 -->
  • 注释必须以 <!-- 开始，以 --> 结束。
  • 注释内容不能包含两个连在一起的连字符（即不能写成 --），也不能以 -- 结尾。

注释不应该嵌套​

HTML 注释不支持嵌套。也就是说，在一条注释中再写一条注释是无效的，而且可能导致浏览器解析出错：

<!-- 外层注释
  <!-- 内层注释（这样是不被支持的） -->
-->

建议始终保持注释语法清晰独立，避免嵌套。

注释的作用​

✅ 注释可以帮助你解释代码​

你可以使用注释为某段 HTML 代码添加说明，帮助自己或他人更好地理解代码的功能。

<!-- 这是一个主标题 -->
<h1>欢迎来到我的网站</h1>

<!-- 以下是一个段落 -->
<p>这里是介绍内容。</p>

在团队协作或后期维护中，注释可以大大提高代码可读性。

✅ 注释可以隐藏代码​

有时你想临时屏蔽某段代码但又不想删除它，可以通过注释来“隐藏”这段代码：

<!-- <p>这段文字不会被显示在浏览器中。</p> -->

浏览器会忽略这段被注释的代码，它既不会渲染出来，也不会报错。

这种方法常用在调试过程中。

✅ 注释可以用于调试 HTML 页面​

在调试网页时，注释是一种快速测试的好方法。你可以将部分代码注释掉，以查看是否是某段代码导致了页面错误或样式异常。

<!--
<div class="sidebar">
  <p>这是侧边栏</p>
</div>
-->

一旦问题找到了，你可以取消注释恢复原始代码。

小结​

HTML 注释是你开发过程中非常实用的工具。它们不仅可以帮助你记录代码意图、提高可读性，还能在调试时起到重要作用。记住，注释不会出现在网页中，只对开发者可见。在写 HTML 页时，养成合理使用注释的习惯，会让你未来维护代码时更加轻松高效。