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 相关文章推荐
JavaScript 以对象为索引的关联数组
May 19 Javascript
使用jQuery UI的tooltip函数修饰title属性的气泡悬浮框
Jun 24 Javascript
浅谈JavaScript之事件绑定
Jul 08 Javascript
jquery中ready()函数执行的时机和window的load事件比较
Jun 22 Javascript
XML、HTML、CSS与JS的区别整理
Feb 18 Javascript
js实现可键盘控制的简单抽奖程序
Jul 13 Javascript
工作中比较实用的JavaScript验证和数据处理的干货(经典)
Aug 03 Javascript
canvas时钟效果
Feb 16 Javascript
深入浅析nuxt.js基于ssh的vue通用框架
May 21 Javascript
vue 兄弟组件的信息传递的方法实例详解
Aug 30 Javascript
layui固定下拉框的显示条数(有滚动条)的方法
Sep 10 Javascript
Vue中点击active并第一个默认选中功能的实现
Feb 24 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中static关键字原理的学习研究分析
2011/07/18 PHP
php+ajax实现带进度条的上传图片功能【附demo源码下载】
2016/09/14 PHP
laravel框架中间件 except 和 only 的用法示例
2019/07/12 PHP
laravel框架实现去掉URL中index.php的方法
2019/10/12 PHP
关于js datetime的那点事
2011/11/15 Javascript
js渐变显示渐变消失示例代码
2013/08/01 Javascript
jQuery处理xml格式的返回数据(实例解析)
2013/11/28 Javascript
js修改原型的属性使用介绍
2014/01/26 Javascript
js获取 type=radio 值的方法
2014/05/09 Javascript
JS自定义混合Mixin函数示例
2016/11/26 Javascript
javascript显示系统当前时间代码
2016/12/29 Javascript
js 原型对象和原型链理解
2017/02/09 Javascript
基于Vuejs和Element的注册插件的编写方法
2017/07/03 Javascript
浅谈AngularJS中$http服务的简单用法
2018/05/15 Javascript
微信小程序实现日历功能
2018/11/27 Javascript
详解node登录接口之密码错误限制次数(含代码)
2019/10/25 Javascript
js实现内置计时器
2019/12/16 Javascript
python简单实现计算过期时间的方法
2015/06/09 Python
Python读取网页内容的方法
2015/07/30 Python
Python远程视频监控程序的实例代码
2019/05/05 Python
python3字符串操作总结
2019/07/24 Python
python内存监控工具memory_profiler和guppy的用法详解
2019/07/29 Python
Python 实现加密过的PDF文件转WORD格式
2020/02/04 Python
浅谈tensorflow 中tf.concat()的使用
2020/02/07 Python
python误差棒图errorbar()函数实例解析
2020/02/11 Python
python GUI库图形界面开发之PyQt5输入对话框QInputDialog详细使用方法与实例
2020/02/27 Python
python使用pandas抽样训练数据中某个类别实例
2020/02/28 Python
html5教程实现Photoshop渐变色效果
2013/12/04 HTML / CSS
青年创业培训欢迎词
2014/01/08 职场文书
政府四风问题整改措施
2014/10/04 职场文书
2014年教研室工作总结
2014/12/06 职场文书
2014年大学宣传部工作总结
2014/12/19 职场文书
大学生个人学习总结
2015/02/15 职场文书
仓库统计员岗位职责
2015/04/14 职场文书
开学典礼校长致辞
2015/07/29 职场文书
Java基于Dijkstra算法实现校园导游程序
2022/03/17 Java/Android