html、css和js注释规范用法小结

来源:爱站网时间:2020-03-21编辑:网友分享
html、css和js注释规范是为了规范大家养成良好的习惯,这样的规范是为了提高代码的可维护性和可读性的,下文是爱站技术频道带给大家的html、css和js注释规范用法小结,让我们一起来科普一下吧。

html、css和js注释规范是为了规范大家养成良好的习惯,这样的规范是为了提高代码的可维护性和可读性的,下文是爱站技术频道带给大家的html、css和js注释规范用法小结,让我们一起来科普一下吧。

html注释:

<!--注释内容-->

css注释:

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

JavaScript:

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

总结:

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

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

1、html注释

使用的位置:

1)一般会使用在一些主要节点标签结束的后边,如:

<div class="wrap">
<div class="main">
...
</div><!--main end-->
<div><!--wrap end-->

2)使用在一些循环的结束的后边,如:

<ul class="list">
    <li>111111</li>
    <li>222222</li>
    <li>333333</li>
</ul><!--list loop-->

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

2、css注释

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

/*通用 - 评论*/
.comment{...}
/*相册*/
.photo{...}
/*分享*/
.share{...}
/*投票*/
.vote{...}

3、javascript注释

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

//========================================================
//      截断字符
//      steepvi
//      rtx:*******
//      2010-10-14
//========================================================

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

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

html、css和js注释规范用法小结爱站技术频道就为各位朋友们整理到这里了,大家看完之后,是不是掌握住了呢 ?只要按照上面的说法操作,就能知道是否像我们想的那样了。

上一篇:HTML标签meta总结,HTML5 head meta 属性整理

下一篇:详解html中的marquee属性

您可能感兴趣的文章

相关阅读

热门软件源码

最新软件源码下载