在实际开发中,我们需要在一些关键的HTML代码旁边标明一下这段代码是干什么,这个时候就要用到“HTML注释”了。
在HTML中,对一些关键代码进行注释,好处有非常多,比如方便理解、方便查找以及方便同一个项目组的小伙伴快速理解你的代码,以便快速修改。
语法:
<!--注释的内容-->
说明:
<!---->又叫注释标签。<!--表示注释的开始,-->表示注释的结束。
举例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>HTML注释</title>
</head>
<body>
<h3>静夜思</h3> <!--标题标签-->
<p>床前明月光,疑是地上霜。</p> <!--文本标签-->
<p>举头望明月,低头思故乡。</p> <!--文本标签-->
</body>
</html>
在浏览器预览效果如下图所示:
分析:
从上面我们可以看出,用<!---->注释的内容不会显示在浏览器中。在HTML中,浏览器遇到HTML标签就会进行解释,然后显示HTML标签中的内容。但是浏览器遇到“注释标签”就会自动跳过,因此不会显示注释标签中的内容。或者我们可以这样理解,HTML标签是给浏览器看的,注释标签是给咱们“程序猿”看的。
为关键代码添加注释是一个良好的习惯。在实际开发中,对功能模块代码进行注释尤为重要。因为一个页面的代码往往都是几百上千行的,如果你不对关键代码进行注释,当翻回头去看自己写的代码时,都会看不懂,更别说团队开发了。不注释的后果是,当其他队友来维护你的项目时,需要花大量时间来理解你的代码,这样就把人家给坑惨了。
此外要说明的是,并不是每一行代码都要注释的。只有重要的、关键的代码才需去注释,这一点小伙伴们别误解了。