JavaScript之编码规范 推荐


Posted in Javascript onMay 23, 2012

一、命名
1、应给变量和函数取一个含义确切的名称,不要随意命名。
2、非构造函数采用驼峰命名法,尽量采用动宾结构,以与变量名相区别,如getName或IsFull。构造函数(即自定义类型)名称首字母大写,以与非构造函数相区别,如Person。
3、变量采用驼峰命名法。由于JavaScript是一种弱类型语言,因此建议在变量名称前加前缀:整形(i),浮点数(f),布尔型(b),字符串(s),数组(a)。但不强制这么做,可根据个人爱好选择,选择好后就不要混用加前缀和不加前缀这两种方式了。

二、布局
1、空格。
a)var与变量名之间留一个空格,变量名与等号之间留一个空格,等号与初始值之间留一个空格,初始值与分号之间不留空格。如:var i = 10;
b)使用字面量方式声明引用类型变量时,各个属性与冒号之间不留空格,冒号与初始值之间留一个空格。如:

var Person = { 
age: 16, 
name: "Sam" 
};

c)function与函数名之间留一个空格,函数名与()之间不留空格,()与{之间留一个空格。
d)函数的各个参数之间留一个空格。
e)if、while、for与左括号之间留一个空格,以强调关键字;switch、with与左括号之间不留空格。
f) 二元操作符与左右两个操作数之间留一个空格。当某行代码较长时,也可不留空格。
2、换行。
a)每行语句占用一行,不要多个语句一行。
b)if、while、for等块级作用域后的大括号{不要另起一行,就放在关键字同一行。
3、缩进。
a)缩进使用4个空格,不要使用tab。
b)作用域不一样时就应当进行缩进,以显示出其层次关系。

三、注释
1、合理添加注释。注释不能完全没有,也不是越多越好。给重要的方法、变量和算法(或其他需要注意的问题)添加注释即可。
2、修改源代码时,需要同步修改注释,保持两者的一致。
3、不要在代码中使用html方式的注释。

四、规范
1、申明变量时必须加var关键字。虽然JavaScript允许不加var关键字,此时成为全局变量,但这是导致问题的一个来源。
2、申明变量时必须同时进行初始化,之后最好不要再改变变量的数据类型了。
3、语句末尾可以加分号的,必须加分号。
4、if、while、for等仅有一条语句时,也需要放在大括号内。
5、不要随意使用全局变量,如果不得不使用,最好只用一个全局变量。
6、JavaScript与html、css之间应保持松散耦合。html是数据层,css是表现层,JavaScript是行为层,三者应避免紧密的耦合,否则会导致后期难以维护。html中不要有具体的JavaScript代码,全部采用包含外部文件的方式;JavaScript中也尽量不要使用innerHTML等插入大量html元素,应考虑将元素放在html中,只不过初始隐藏即可;JavaScript中不要直接修改css中的具体属性,而应通过className来间接修改。
7、不要修改不是由你所有的对象,不给其实例或原型添加属性或方法,也不要重复定义其已有的方法。否则,当该对象的新版本添加了同名的属性或方法时,会导致潜在的难以察觉的问题。解决方案有两种:一是继承,二是包含。
8、使用命名空间来防止多个库之间的冲突,可参考YUI库的组织方式。
9、对于代码中出现的字面量,应将其放在某个变量的属性中,属性名首字母或所有字母大写(模拟其他语言中的define或enum)。如:

var Color = { 
RED: 1, 
BLUE: 2, 
GREEN: 3 
};

10、对函数中传入的参数进行检查。若为基本类型,使用typeof;若为引用类型,使用instanceOf;若要检查某个对象是否包含某个方法,则对该方法使用typeof操作符,并与字符串"undefined"比较。

五、性能
1、避免全局查找。使用全局变量和函数的开销要比使用局部变量和函数大,因为全局变量和函数涉及到作用域链的查找。因此,当函数中多次使用全局变量时,就会进行多次作用域链的查找,为了避免这个问题,可以将多次使用的全局变量赋值给一个局部变量,以后都使用该局部变量。
2、避免使用witch语句。with语句会创建自己的作用域,从而导致额外的开销。
3、避免属性查找。属性查找是一个O(n)操作,对象上的任何属性查找都比访问变量和数组花费更多时间(访问变量和数组是O(1)操作)。因此,如果多次用到同一个属性,则应将其保存在局部变量中。如:

var sUrl = window.location.href; 
var sData = sUrl.substring(sUrl.indexOf("?"));
Javascript 相关文章推荐
jQuery学习笔记之Helloworld
Dec 22 Javascript
jquery实现商品拖动选择效果代码(自写)
May 28 Javascript
javascript阻止scroll事件多次执行的思路及实现
Nov 08 Javascript
浅析JavaScript中的delete运算符
Nov 30 Javascript
JavaScript数据结构之二叉树的计数算法示例
Apr 13 Javascript
将angular-ui的分页组件封装成指令的方法详解
May 10 Javascript
关于Vue单页面骨架屏实践记录
Dec 13 Javascript
Vue.js中使用iView日期选择器并设置开始时间结束时间校验功能
Aug 12 Javascript
在vue中多次调用同一个定义全局变量的实例
Sep 25 Javascript
基于Taro的微信小程序模板消息-获取formId功能模块封装实践
Jul 15 Javascript
electron踩坑之dialog中的callback解决
Oct 06 Javascript
vue任意关系组件通信与跨组件监听状态vue-communication
Oct 18 Javascript
javascript的数据类型、字面量、变量介绍
May 23 #Javascript
网页源代码保护(禁止右键、复制、另存为、查看源文件)
May 23 #Javascript
通过js动态操作table(新增,删除相关列信息)
May 23 #Javascript
JavaScript基础语法让人疑惑的地方小结
May 23 #Javascript
利用javascript解决图片缩放及其优化的代码
May 23 #Javascript
JavaScript 图像动画的小demo
May 23 #Javascript
JavaScript学习笔记记录我的旅程
May 23 #Javascript
You might like
在PHP站点的页面上添加Facebook评论插件的实例教程
2016/01/08 PHP
PHP图形计数器程序显示网站用户浏览量
2016/07/20 PHP
PHP通过加锁实现并发情况下抢码功能
2016/08/10 PHP
jQuery 1.0.4 - New Wave Javascript(js源文件)
2007/01/15 Javascript
prototype 学习笔记整理
2009/07/17 Javascript
图片轮换效果实现代码(点击按钮停止执行)
2013/04/12 Javascript
JS性能优化笔记搜索整理
2013/08/21 Javascript
js获取触发事件元素在整个网页中的绝对坐标(示例代码)
2013/12/13 Javascript
简单选项卡 js和jquery制作方法分享
2014/02/26 Javascript
jQuery链使用指南
2015/01/20 Javascript
浅析Node.js中的内存泄漏问题
2015/06/23 Javascript
jQuery获取radio选中项的值实例
2016/06/18 Javascript
javascript 正则表达式分组、断言详解
2017/04/20 Javascript
代码详解javascript模块加载器
2018/03/04 Javascript
处理JavaScript值为undefined的7个小技巧
2020/07/28 Javascript
Python struct.unpack
2008/09/06 Python
python网页请求urllib2模块简单封装代码
2014/02/07 Python
python实现爬虫下载漫画示例
2014/02/16 Python
Python fileinput模块使用实例
2015/06/03 Python
python实现web方式logview的方法
2015/08/10 Python
Python 字符串大小写转换的简单实例
2017/01/21 Python
Python编程实现及时获取新邮件的方法示例
2017/08/10 Python
tensorflow 获取变量&打印权值的实例讲解
2018/06/14 Python
python format 格式化输出方法
2018/07/16 Python
Python Numpy库安装与基本操作示例
2019/01/08 Python
使用Python的datetime库处理时间(RPA流程)
2019/11/24 Python
python 插入日期数据到Oracle实例
2020/03/02 Python
pip install 使用国内镜像的方法示例
2020/04/03 Python
django-orm F对象的使用 按照两个字段的和,乘积排序实例
2020/05/18 Python
css3实现的多级渐变下拉菜单导航效果代码
2015/08/31 HTML / CSS
Java里面StringBuilder和StringBuffer有什么区别
2016/06/06 面试题
自主招生教师推荐信
2014/05/10 职场文书
关于有小孩的离婚协议书
2014/10/26 职场文书
无工作证明怎么写
2015/06/15 职场文书
《夜莺的歌声》教学反思
2016/02/22 职场文书
2016年大学生社区服务活动总结
2016/04/06 职场文书