使用 HTML 注释 <!-- … -->
HTML 注释 主要用于为标记添加解释性说明,或防止浏览器解释文档的特定部分。
注释以字符串
<!--
开始,字符串
-->
结束,其中间是一些文本。这些文本不能以字符串
>
或
->
开头,不能包含字符串
-->
或
--!>
,也不能以字符串
<!-
结束,但允许字符串
<!
出现。
当渲染代码时,浏览器会忽略注释。也就是说,它们在页面中不可见——只在代码中可见。HTML 注释是为代码或逻辑编写有用注释的一种方式。
上述情况同样适用于
XML
注释。此外,在 XML 中,例如在
SVG
或
MathML
标记中,注释不能包含字符序列
--
。
注释可以在单行中使用,也可以跨越多行。它们可以在这些地方使用:
<html>
元素之前或之后
<script>
、
<style>
、
<title>
、
<textarea>
,因为这些元素将其内容解释为原始文本
<script>
元素不应使用 HTML 注释,而应使用
JavaScript 注释
,但有一种传统做法是将整个脚本内容包含在 HTML 注释中,这样不支持 JavaScript 的古老浏览器就不会将其渲染为文本。现在,这种做法已成为
JavaScript 自身的遗留特性
,不应再依赖它。