添加必要的注释,对一个有责任心、有道德模范的前端必须具备的好习惯,可以大大提高代码的可维护性、可读性。首先大家需要熟悉一下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注释规范用法小结,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!
本文实例讲述了AJAX+Servlet实现的数据处理显示功能。分享给大家供大家参考,具...
本文转载自微信公众号「SQL数据库」,作者丶平凡世界 。转载本文请联系开发公众...
大家好,我是狂聊君。 今天来聊一聊 Mysql 缓存池原理。 提纲附上,话不多说,直...
CKeditor,以前叫FCKeditor,已经使用过好多年了,功能自然没的说。最近升级到3....
来源:DeepenStudy 漏洞文件:js.asp % Dimoblog setoblog=newclass_sys oblog.a...
问题:我们在做flex的开发中,如果用到别人搭建好的框架,而别人的server名称往...
本文转载自微信公众号「SH的全栈笔记」,作者SH。转载本文请联系SH的全栈笔记公...
在Flash Player 10.1及以上版本中,adobe新增了全局错误处理程序UncaughtErrorEv...
idea官方推送了2020.2.4版本的更新,那么大家最关心的问题来了,之前激活idea202...
前言 项目开发中不管是前台还是后台都会遇到烦人的null,数据库表中字段允许空值...