注释代码如何写_html单行与多行注释语法规范

作者:袖梨 2026-07-21
<p>HTML注释只有一种语法,即<!-- -->,天然支持跨行,不存在单行或多行之分;浏览器仅识别首尾标记,中间换行缩进均被忽略,但禁止出现--或-->等触发提前终止的字符。</p>

HTML 注释只有一种语法,没有单行/多行之分

HTML 标准里根本不存在“单行注释”或“多行注释”的语法区分——<!-- --> 就是唯一合法形式,它天然支持跨行。所谓“单行”,只是你写在一行里;所谓“多行”,只是你在 <!----> 之间手动换了几行。浏览器只认头尾标记,中间换多少次行、缩进几格,全被忽略。

常见错误现象:

  • 以为 ///* */ 能在 HTML 里用 → 实际会原样输出到页面,甚至破坏结构
  • 编辑器快捷键(如 VS Code 的 Ctrl+/)对选中多行只包首尾 → 容易漏掉某行,导致部分代码裸露
  • 复制粘贴一段带缩进的 HTML 到注释里,末尾忘了补 --> → 后续所有 HTML 都不渲染

注释里不能出现 ----> 这类组合

HTML 解析器遇到第一个 -- 就会提前结束注释,哪怕后面还有内容。比如 <!-- 这里--不能这样写 -->,实际只注释了 这里,后面的 不能这样写 --> 会作为普通文本显示,还可能触发解析错误。

使用场景限制:

立即学习“前端免费学习笔记(深入)”;

  • 要写“减号”或“破折号”,加空格隔开:写成 - -(em dash)更安全
  • 要包含大于号 >,避免紧贴 -- 出现,例如不要写 -->,可拆成 -- >
  • 模板引擎动态插入内容时,先对变量做转义,尤其是 >- 连续出现的情况

哪些位置绝对不能写注释

注释不是万能胶,插错地方等于删代码。最常踩坑的是这几种:

  • DOCTYPE 前面放注释 → 某些旧版 IE 直接触发怪异模式
  • 标签内部写注释,比如 <div class="x">> → 语法错误,标签直接失效<li><code><script></script><style></style> 标签内部用 <!-- 开头 → 老式写法,现在完全没必要,反而可能被当 HTML 注释起点,导致 JS/CSS 不执行
  • CDTA 区块(如 <![CDATA[...]]>)里混注释 → 解析混乱,优先用 JS/CSS 层级控制显隐

临时禁用大段 HTML 时,整块包裹比逐行注释更可靠

想屏蔽一个 <section> 及其全部子元素?别用多个 <!-- --> 包每行,直接把整个结构塞进一对 <!----> 里。VS Code 等编辑器的“多行注释”快捷键(Shift+Alt+A)就是干这个的。

但要注意:

  • 确保起始 <!-- 前后有空格,结尾 --> 前也留空格,提升可读性:<!-- <header>...</header> -->
  • 如果被注释的代码本身含 -->,先人工检查或改用 JS 控制 display: none 更稳妥
  • 团队协作时,在注释开头标作用域和日期,比如:<!-- [user-profile]: 旧版卡片组件 | 2026-04-10 -->

真正容易被忽略的是:注释内容本身会被所有人看到,包括生产环境的源码查看者。所以别在注释里留测试账号、内部路径或“这里有问题但懒得修”这类话。

相关文章

精彩推荐