HTML 词条目录
前端Wiki/词条/HTML 注释

HTML 注释

定义给开发者看的说明文字,浏览器解析时整段忽略

注释写在一对尖括号加两个横线之间,可以跨行,用来标注区块功能、留给接手同事的备忘、或者临时注释掉一段代码做调试。大型模板里,结构清晰的注释是导航灯塔——看到区块名字就能定位,不必通读几百行嵌套。发布前是否剥离注释是个争议话题:剥离省字节,保留便于线上排错,团队可按项目定基调,关键是全项目保持一致。

注释的禁忌也很多:不要写显而易见的废话(注释按钮是按钮),不要把敏感信息写进去(数据库密码出现在线上注释里是真实事故),注释掉的死代码定期清理避免越堆越多。还有人把注释当草稿箱,注释掉的代码越积越多,最后谁也不敢删。还有一个经典陷阱:注释内部不能再出现一对注释符号,否则注释会提前结束,后面的内容全部炸出来渲染到页面上。

HTML
<style>
  .demo { border: 1px solid #4a9eff; border-radius: 8px; padding: 12px; }
</style>
<!-- 这里是页头区块:含 Logo 与导航 -->
<div class="demo">
  <p>页头内容</p>
  <!--
    多行注释:上线前请删除调试代码
    <p>这段是临时调试内容</p>
  -->
  <p>正文正常显示,被注释的内容不会渲染。</p>
</div>
<!-- 页尾:版权与备案信息 -->
⚠ 常见误区
🔗 相关词条编码风格标签
← 返回来源章节编码风格