首页 > 代码库 > html、css和js注释的规范用法

html、css和js注释的规范用法

2024-09-22 10:27:22   215人阅读

成为专业的前端工程师！！！

 

 

html注释：

 

<!--注释内容-->

 

css注释：

 

//注释内容 单行注释（不推荐使用，因为有的浏览器可能不兼容，没有效果）
/*注释内容*/ 多行注释（推荐使用）

 

JavaScript：

 

//注释内容 单行注释
/*注释内容*/ 多行注释

 

总结：

 

//注释内容 （在css或javascript中插入单行注释）
/*注释内容*/ （在css或javascript中插入多行注释)

 

接下来是对注释在这几种代码中使用的位置，如何写注释进行总结一下。（根据个人的习惯可能不一样）

 

1、html注释

 

使用的位置：

 

1）一般会使用在一些主要节点标签结束的后边，如：

 

 

 

1
2
3
4
5
<p class="wrap">
<p class="main">
...
</p><!--main end-->
<p><!--wrap end-->

 

2）使用在一些循环的结束的后边，如：

 

 

 

1
2
3
4
5
<ul class="list">
    <li>111111</li>
    <li>222222</li>
    <li>333333</li>
</ul><!--list loop-->

 

这一切都是为了程序在嵌套的时候更加方便、明了。方便了他人同时也就方便了自己。程序嵌套的很乱，到时要你去修改那也是一份挺复杂的工序。

 

2、css注释

 

一般会使用在定义某个模块样式的上边，说明这段样式是作用于哪段模块，如：

 

 

 

1
2
3
4
5
6
7
8
/*通用 - 评论*/
.comment{...}
/*相册*/
.photo{...}
/*分享*/
.share{...}
/*投票*/
.vote{...}

 

3、javascript注释

 

一般将注释添加在某段功能函数的上边，说明函数的功能、作者、作者信息、修改时间。

 

 

 

1
2
3
4
5
6
//========================================================
//      截断字符
//      steepvi
//      rtx:*******
//      2010-10-14
//========================================================

 

最后，注释也是字符也是会有流量产生。因此当页面发布到正式地址的时候，最好加上一步优化流程。

 

压缩过程为非逆过程，保证本地是最新的而且带有注释的文件，压缩后上传服务器。服务器端的文件不可用作本地调试用。

 

html、css和js注释的规范用法


联系
我们