HTML页面注释的基本格式
在编写网页时,经常需要给代码加上说明,让别人或者以后的自己能快速看懂。这时候就要用到HTML注释。注释不会在浏览器里显示,只出现在源码中。
HTML注释的写法是用 <!-- 和 --> 把内容包起来。比如:
<!-- 这是一个页眉区域 -->
<header>
<h1>网站标题</h1>
<nav>导航菜单</nav>
</header>多行注释也是同样规则
哪怕内容占了好几行,只要开头是 <!--,结尾是 --> 就行。例如:
<!--
以下部分为产品列表
每个li代表一个商品
注意class命名规范
-->
<ul class="product-list">
<li>商品A</li>
<li>商品B</li>
</ul>注释的实际用途
有时候团队协作开发,你写的代码别人要接手修改。加几句注释能省去很多沟通成本。比如:
<!-- 轮播图容器,JS会自动初始化 -->
<div id="slider">...</div>再比如临时不想删某段代码,但又不想让它生效,可以直接注释掉:
<!--
<footer>
<p>旧版页脚,暂不使用</p>
</footer>
-->注意事项
注释里不能嵌套注释。也就是说,如果你已经在一个 <!-- ... --> 里面,就不要再写一对 <!-- 和 -->,否则会出错。浏览器可能只识别第一对,导致后面代码混乱。
另外,虽然注释不会显示,但用户查看源码时还是能看到。所以别在注释里写敏感信息,比如密码、内部路径之类。
日常写项目时,适当加点注释就像做饭时放盐,太少看不清逻辑,太多又显得啰嗦。找到平衡就好。