html、css和js注释的规范用法
程序员文章站
2022-03-18 10:47:53
...
添加必要的注释,对一个有责任心、有道德模范的前端必须具备的好习惯,可以大大提高代码的可维护性、可读性。下面小编给大家介绍下html、css和js注释规范用法小结,需要的的朋友参考下吧
添加必要的注释,对一个有责任心、有道德模范的前端必须具备的好习惯,可以大大提高代码的可维护性、可读性。首先大家需要熟悉一下html、css、js的注释的写法:
html注释:
<!--注释内容-->
css注释:
//注释内容 单行注释(不推荐使用,因为有的浏览器可能不兼容,没有效果)
/*注释内容*/ 多行注释(推荐使用)
JavaScript:
//注释内容 单行注释
/*注释内容*/ 多行注释
总结:
//注释内容 (在css或javascript中插入单行注释)
/*注释内容*/ (在css或javascript中插入多行注释)
接下来是对注释在这几种代码中使用的位置,如何写注释进行总结一下。(根据个人的习惯可能不一样)
1、html注释
使用的位置:
1)一般会使用在一些主要节点标签结束的后边,如:
<p class="wrap"> <p class="main"> ... </p><!--main end--> <p><!--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注释的规范用法的详细内容,更多请关注其它相关文章!
推荐阅读
-
dynamic-css 动态 CSS 库,使得你可以借助 MVVM 模式动态生成和更新 css,从 js 事件和 css 选择器的苦海中脱离出来_html/css_WEB-ITnose
-
css3的基础用法,新手必看哈(还有css3和jquery动画的对比)_html/css_WEB-ITnose
-
关于html和css以及javascript等其他的注释方式分享
-
id和name那个是用来标记锚点的标准用法?_html/css_WEB-ITnose
-
html/css中相对定位relative和绝对定位absolute的用法
-
如何使用php脚本给html中引用的js和css路径打上版本号
-
详解require.js配置路径的用法和css的引入
-
nodejs分离html文件里面的js和css的方法
-
使用nodejs分离html文件里的js和css详解
-
2020-07-11 html的rtl网站的适配 + css的pt单位应用 + JS的实现撤销和重做 + 位 字节 字符的区别