HTML 教程 / HTML注释

HTML 注释

注释是对代码的说明,不会被浏览器显示。合理使用注释是编写高质量代码的重要习惯。

注释语法

使用 <!-- 开始,--> 结束注释。

示例
<!-- 这是注释内容 --> 

注释的用途

  • 解释代码功能:说明某个区块的用途
  • 暂时禁用代码:调试时临时注释掉代码
  • 添加说明文档:记录作者、日期、版本等信息
  • 代码组织:用注释划分代码区块
示例
<!-- 页面标题 -->
<h1>欢迎</h1>

<!-- 暂时禁用这段代码
<p>这段内容不显示</p>
--> 

注释的最佳实践

  • 保持简洁:注释应该简明扼要
  • 说明"为什么"而非"是什么":代码本身已经说明了是什么
  • 及时更新:修改代码后记得更新注释
  • 避免过度注释:不要为每行代码都加注释
多行注释

HTML注释可以跨越多行:

示例
<!--
这是一个多行注释
可以写很多内容
--> 
注意
  • 注释内容不会被浏览器渲染,但可以通过"查看页面源代码"看到
  • 不要在注释中放置敏感信息
  • 条件注释 IE已不推荐使用
提示

合理使用注释可以提高代码的可读性和可维护性。