使用 HTML 注释 <!-- … -->
HTML 注释用于在标记中添加说明性注释,或阻止浏览器解释文档的特定部分。
注释以字符串 <!--
开始,以字符串 -->
结束,中间通常包含文本。此文本不能以字符串 >
或 ->
开头,不能包含字符串 -->
或 --!>
,也不能以字符串 <!-
结尾,但允许 <!
。
浏览器在渲染代码时会忽略注释。换句话说,它们在页面上不可见——只在代码中可见。HTML 注释是您为代码或逻辑编写有用说明的一种方式。
上述说法同样适用于 XML 注释。此外,在 XML 中,例如在 SVG 或 MathML 标记中,注释不能包含字符序列 --
。
注释可以单行使用,也可以跨越多行使用。它们可以在以下位置使用
- 在 Doctype 之前和之后
- 在
<html>
元素之前和之后 - 作为大多数元素的(块级)内容,但以下元素除外:
<script>
、<style>
、<title>
、<textarea>
,因为这些元素将其内容解释为纯文本
注意:虽然 <script>
元素不应包含 HTML 注释,而应使用 JavaScript 注释,但过去有一种将整个脚本内容包含在 HTML 注释中的做法,以便不支持 JavaScript 的旧式浏览器不会将其渲染为文本。这现在是 JavaScript 本身的一项遗留功能,您不应依赖它。
语法
html
<!-- Comment -->
示例
html
<!-- A one-line comment -->
<!--
A comment
that stretches
over several
lines
-->
<!-- The comment below disables
the HTML contained within -->
<!--
<p>
This content will not be rendered.
</p>
-->
注意
HTML 注释仅允许作为内容。您不能在标签内使用它,例如在 HTML 属性之前。
与大多数使用 <!-- -->
注释语法的编程语言一样,注释不能嵌套。换句话说,紧跟在 <!--
之后的第一个 -->
会关闭注释。
虽然注释以 <
开始,以 >
结束,但注释不是 HTML 元素。
规范
规范 |
---|
HTML # 注释 |
另见
- JavaScript 中的注释
- CSS 中的注释
Comment
API (Comment
继承自Node
)