HTML 注释
提示
- HTML注释格式:HTML注释以
<!--
开头,以-->
结束,用于添加代码说明。 - 注释的作用:注释增加代码可读性,对其他开发者有帮助,但不会在浏览器中显示。
- 注释中的HTML元素:在注释中放置的HTML元素会被忽略,不会在网页上显示。
HTML 注释用于向网页插入注释。例如,
<!-- 标题 2 -->
<h2>HTML 中的注释</h2>
这里,<!-- 标题 2 -->
是一个注释。在 HTML 中,注释以 <!--
开始并以 -->
结束。
浏览器不会显示 HTML 注释。它们用于在代码中添加文档说明性的注释。例如,
<!-- 一个 HTML div -->
<div>
<p>学习 HTML 很有趣。</p>
</div>
浏览器输出
这里,
<!-- 一个 HTML div -->
是一个注释。因此,它在浏览器输出中不会显示。
为什么使用 HTML 注释?
注释主要用于使我们的代码更具可读性。它们在网页上完全隐藏,只在代码中显示。
对代码进行注释是一种良好的实践,因为它有助于我们表达代码的作用。如果将来你想更改代码,注释可以作为你的参考。
在协作环境中,代码注释对其他开发人员也有帮助。
注意:尽管浏览器不显示注释,但仍然可以使用浏览器的 查看源代码 功能查看注释。这就是为什 么我们不应在注释中添加敏感信息的原因。
单行和多行注释
在 HTML 中,我们使用相同的语法来创建单行和多行注释。
单行注释
<!-- 写一个标题 -->
<h1>重要标题</h1>
多行注释
<!-- 多行注释
可以包含换行符
以及额外的 空格 -->
<p>这将在网页中显示</p>
注释中的 HTML 标签
如果我们在注释中放置 HTML 元素,它们将被忽略。例如,
<p>这将被显示</p>
<!-- <p>这将不被显示</p> -->
<p>这也将被显示</p>
浏览器输出
HTML 注释的键盘快捷键
大多数代码编辑器都有注释代码的键盘快捷键。
通常,大多数代码编辑器使用 Ctrl + /
(在 Windows 或 Linux 上)和 Cmd + /
(在 Mac 上)来创建注释。
我们鼓励你记住这些快捷键,因为注释经常被用来添加额外信息,以及临时移除某些代码。