html、css和js注释规范用法小结
57 浏览量
2020-09-28
04:33:30
上传
评论
收藏 53KB PDF 举报
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
评论0
最新资源