HTML: HTML 注释
注释是为开发人员而撰写的文本说明。浏览器会完全忽略这些注释。明智地使用注释能够极大地提高代码的可读性,并促进团队协作。
1. 注释的语法
HTML 注释以 <!-- 开头,以 --> 结尾。中间的内容可以是任意文字,浏览器不会展示在页面上:
▶ 示例
HTML
<!-- 这是一个注释,用户看不到我 -->
<p>这段文字用户可以看到。</p>
<!-- ======= 导航区域开始 ======= -->
<nav>
<a href="index.html">首页</a>
<a href="about.html">关于我们</a>
</nav>
<!-- ======= 导航区域结束 ======= -->
📌 注意: 注释的内容虽然在页面上不可见,但仍然会出现在 HTML 源码中——任何人都可以通过"查看网页源代码"看到你的注释。不要在注释里写密码或敏感信息。
2. 注释的常见用途
注释不只是用来写说明文字,在开发调试中也非常有用:
▶ 示例
HTML
<!-- 临时注释掉一段代码(调试用) -->
<!--
<p>这段代码暂时不需要显示。</p>
<a href="old-page.html">旧链接</a>
-->
<!-- TODO: 后续需要加上用户头像 -->
<!-- @张三 2026-06-12: 这里的文案确认后再上线 -->
💡 最佳实践: 注释的作用是解释为什么这么写,而不是怎么写。好的代码本身应该是自解释的,注释只补充代码无法表达的上下文。另外,上线前记得清理掉调试用的注释代码。
❓ 常见问题
Q HTML注释会被用户看到吗?
A 注释不会在页面上显示,但任何人都可以通过"查看网页源代码"(右键→查看页面源代码)看到你的注释。所以绝对不要在注释中写密码、API密钥、内部逻辑等敏感信息。注释是给开发者看的,不是给用户看的。上线前建议清理掉调试用的注释。
Q 注释可以嵌套吗?
A 不可以。HTML注释不支持嵌套——你不能在一个注释内部再写一个
<!-- -->。如果尝试嵌套,浏览器会把第一个-->当作注释的结束,后面的内容就会暴露在页面上。如果需要注释掉一大段已包含注释的代码,建议用CSS的display:none或JavaScript来控制显示隐藏。Q 注释里可以写什么内容?
A 注释可以包含任何文字、换行和空格,但不能包含
--(双连字符),因为这可能被误解析为注释的结束。常见用途:1)区段标记(如<!-- 导航开始 -->);2)TODO标记(如<!-- TODO: 添加搜索功能 -->);3)临时屏蔽代码(调试用);4)作者信息(如<!-- @张三 2026-06-12 -->)。📖 小节
- 注释以
<!--开头,-->结尾,浏览器不会显示 - 注释可用于说明代码区块、临时屏蔽代码、添加 TODO 标记
- 注释内的敏感信息会被所有人看到,不要放密码
- 上线前清理调试注释,保持源码整洁
📝 作业
- 给代码加注释:写一个包含导航和正文的简单页面,在每个区块前后加上区段注释标记(如
<!-- 导航开始 -->)。 - 注释调试:复制之前某节课的代码,用注释临时"隐藏"其中一段,确认隐藏的部分确实不在页面显示。