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 EasyUI API 中文文档 - Tree树使用介绍
Nov 19 Javascript
『jQuery』取指定url格式及分割函数应用
Apr 22 Javascript
基于jquery中children()与find()的区别介绍
Apr 26 Javascript
js setTimeout 常见问题小结
Aug 13 Javascript
jQuery实现自动滚动到页面顶端的方法
May 22 Javascript
微信小程序实现下拉刷新和轮播图效果
Nov 21 Javascript
[原创]jquery判断元素内容是否为空的方法
May 04 jQuery
vue中的数据绑定原理的实现
Jul 02 Javascript
超好用的jQuery分页插件jpaginate用法示例【附源码下载】
Dec 06 jQuery
vue 项目 iOS WKWebView 加载
Apr 17 Javascript
JS实现排行榜文字向上滚动轮播效果
Nov 26 Javascript
JS pushlet XMLAdapter适配器用法案例解析
Oct 16 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 for 循环语句使用方法详细说明
2010/05/09 PHP
php下连接ftp实现文件的上传、下载、删除文件实例代码
2010/06/03 PHP
简单介绍PHP的责任链编程模式
2015/08/11 PHP
PHP设置images目录不充许http访问的方法
2016/11/01 PHP
PHP命令空间namespace及use的用法小结
2017/11/27 PHP
extjs grid取到数据而不显示的解决
2008/12/29 Javascript
基于jquery的超简单上下翻
2010/04/20 Javascript
validator验证控件使用代码
2010/11/23 Javascript
基于jquery插件实现常见的幻灯片效果
2013/11/01 Javascript
js转化毫秒为时间格式代码
2014/04/10 Javascript
Javascript Objects详解
2014/09/04 Javascript
jquery通过closest选择器修改上级元素的方法
2015/03/17 Javascript
简单实现JS倒计时效果
2016/12/23 Javascript
javascript replace()第二个参数为函数时的参数用法
2016/12/26 Javascript
js实现淡入淡出轮播切换功能
2017/01/13 Javascript
Node.js实现注册邮箱激活功能的方法示例
2018/03/23 Javascript
详解vue项目接入微信JSSDK的坑
2018/12/14 Javascript
mpvue小程序循环动画开启暂停的实现方法
2019/05/15 Javascript
vue项目中定义全局变量、函数的几种方法
2019/11/08 Javascript
在微信小程序中渲染HTML内容3种解决方案及分析与问题解决
2020/01/12 Javascript
js canvas实现五子棋小游戏
2021/01/22 Javascript
linux系统使用python监测系统负载脚本分享
2014/01/15 Python
Python入门之三角函数atan2()函数详解
2017/11/08 Python
pytest中文文档之编写断言
2019/09/12 Python
Python如何把十进制数转换成ip地址
2020/05/25 Python
在django中查询获取数据,get, filter,all(),values()操作
2020/08/09 Python
css3 伪类选择器快速复习小结
2019/09/10 HTML / CSS
html5 Canvas画图教程(5)—canvas里画曲线之arc方法
2013/01/09 HTML / CSS
俄罗斯EPL钻石珠宝店:ЭПЛ
2019/10/22 全球购物
运动鞋、街头服装、手表和手袋的实时市场:StockX
2020/11/25 全球购物
电子商务毕业生求职信
2013/11/10 职场文书
《孔子拜师》教学反思
2014/02/24 职场文书
幼儿园清明节活动总结
2014/07/04 职场文书
小班上学期个人总结
2015/02/12 职场文书
护理专业自我评价
2015/03/11 职场文书
python DataFrame中stack()方法、unstack()方法和pivot()方法浅析
2022/04/06 Python