HTML 注释语法
在 HTML 中,为一些关键代码注释是非常有必要的。注释的好处很多,比如方便理解、方便查找或方便项目组里的其他开发人员了解你的代码,而且也方便以后你对自己的代码进行修改。
在 HTML 中,我们可以使用 “<!--” 和 “-->” 这一对标记符号来注释内容。其中,“<!---->” 也叫做注释标签。
语法:
<!--注释的内容-->说明:
“<!--” 表示注释的开始, “-->” 表示注释的结束,然后需要注释的内容放在 “<!--” 和 “-->” 之间。
不同语言的注释可能会不一样。CSS 和 JavaScript 这两个的注释语法,与 HTML 注释的是不一样的。另请参阅:
注意: 并非每一行代码都要注释,只有重要的、关键的代码才需去注释。为 HTML 添加注释的目的在于,提高代码的可读性和可维护性。
HTML 注释作用
在 HTML 中,注释主要有以下 2 个方面的作用。
1. 解释代码(给队友看)
当代码结构复杂时,我们需要用注释来标记 “这里是头部”、“这里是广告栏”,方便自己或同事日后维护。
示例 1:HTML 注释用于解释代码
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title></title>
</head>
<body>
<!--这是网站标题-->
<div class="header">
<h3>绿叶网</h3>
</div>
<!--这是正文内容-->
<div class="main">
<p>为好教程,全力以赴。</p>
</div>
</body>
</html>页面效果如下图所示。

分析:
从页面效果可以看出,使用 “<!---->” 注释的内容不会显示在浏览器中。一般情况下,浏览器遇到 HTML 标签就会进行解析,然后显示 HTML 标签中的内容。但浏览器遇到 “注释标签” 就会自动跳过,因此不会显示注释标签中的内容。或者我们可以这样理解,HTML 标签是给浏览器看的,注释标签是给咱们 “程序猿” 看的。
为关键代码添加注释是一个良好的习惯。在实际开发中,对功能模块代码进行注释尤为重要。因为一个页面的代码往往都是几百上千行的,如果你不对关键代码进行注释,当翻回头去看自己写的代码时,都会看不懂,更别说团队开发了。
不注释的后果是,写出来的代码容易变成 “屎山代码”,当其他队友来维护你的项目时,需要花大量时间来理解你的代码,这样就把人家给坑惨了。

2. 屏蔽代码(用于调试)
当你发现某段代码可能有问题,或者某个功能暂时不想上线,但又不想直接删除(怕以后要用),就可以把它 “注释掉”。这可以说是新手必须掌握的 “调试神器”!
示例 2:HTML 注释用于屏蔽代码
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title></title>
</head>
<body>
<div class="header">
<h3>绿叶网</h3>
</div>
<div class="main">
<p>为好教程,全力以赴。</p>
</div>
<!-- <div class="footer">
<p>版权声明</p>
</div> -->
</body>
</html>页面效果如下图所示。

分析:
<!-- <div class="footer">
<p>版权声明</p>
</div> -->由于上面这段代码使用 HTML注释给 “注释掉” 了,因此不会在页面中显示。在 VSCode 等主流编辑器中,我们可以先使用鼠标来选中某一段代码,然后使用下面快捷键来进行 “注释” 或 “取消注释”。
- Windows:
Ctrl + /。 - Mac:
Command + /。
如果一段代码未被注释,使用上面快捷键则会将其 “注释” 掉。如果一段代码已经被注释了,使用上面快捷键则会将其 “取消注释” 。
注意: HTML 注释不支持嵌套!千万不要在注释里面再写注释,否则会导致注释提前结束,剩下的代码会直接暴露在页面上,甚至破坏整个网页布局。
