JavaScript之编码规范 推荐

一、命名
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("?"));

赞 (0)

相关推荐

  • 如何写好你的JavaScript【推荐】

    前言 在实际工作中,我们应该经常会看到一些功能上没有问题,但编码风格和规范却十分糟糕的代码,这往往会让人不敢再往下阅读,甚至会影响阅读者一天的心情.这些代码不仅不易阅读,而且难以维护,它们一般会出自刚入门的编程新手,也会出自工作了好几年的老程序员手下.因此本文的目的在于帮助那些没有养成良好的编码风格,缺乏相应编码规范意识的JavaScript学习者们改善他们的编码形象. 编码形象 以上我提出了编码形象的概念,我个人认为: 编码形象 = 编码风格 + 编码规范 一个良好的编码形象就等于一个穿着得体

  • Node.js编码规范

    调用函数的时候,函数名与左括号之间没有空格. 函数名与参数序列之间,没有空格:所有其他语法元素与左括号之间,都有一个空格. 使用小驼峰式命名法作为所有变量和属性的命名规则. 缩进使用两空格,统一使用单引号. 关联数组,除非键名中有空格或是非法字符,否则一律不用引号. 不要将不同目的的语句,合并成一行. 不要省略句末的分号,哪怕一行只有一个语句. 不要使用自增(++)和自减(--)运算符,用+=和-=代替. 不要使用"相等"(==)运算符,只使用"严格相等"(===)

  • 最全的Javascript编码规范(推荐)

    最全的Javascript编码规范(推荐)

    1.嵌入规则 Javascript程序应该尽量放在.js的文件中,需要调用的时候在页面中以<script src="filename.js">的形式包含进来.Javascript代码若不是该页面专用的,则应尽量避免在页面中直接编写Javascript代码. 2.对齐缩进与换行 a) 缩进 在同一系统中应采用同一种缩进标准,本文提倡缩进大小为4个空格.各编译器对Tab键所代替的空白大小定义不同.建议在设置开发环境时,将编辑器里的Tab快捷键重新设置成4个空格.多数编译器提供了

  • 浅谈JavaScript编程语言的编码规范

    JavaScript 编程语言作为最流行的客户端脚本语言,早已被众多 Web 开发人员所熟悉.随着 Web2.0 时代的到来和 Ajax 技术的广泛应用,JavaScript 也逐渐吸引着更多的视线.工作中要求越多的是对 JavaScript 语言的深入学习,灵活运用,和对编码质量的保证. 对于熟悉 C/C++ 或 Java 语言的工程师来说,JavaScript 显得灵活,简单易懂,对代码的格式的要求也相对松散.很容易学习,并运用到自己的代码中.也正因为这样,JavaScript 的编码规范也

  • 前端编码规范（3）JavaScript 开发规范

    JavaScript规范 变量声明 总是使用 var 来声明变量.如不指定 var,变量将被隐式地声明为全局变量,这将对变量难以控制.如果没有声明,变量处于什么定义域就变得不清(可以是在 Document 或 Window 中,也可以很容易地进入本地定义域).所以,请总是使用 var 来声明变量. 采用严格模式带来的好处是,当你手误输入错误的变量名时,它可以通过报错信息来帮助你定位错误出处. 变量名 变量名推荐使用驼峰法来命名(camelCase) 全局变量为大写 (UPPERCASE ) 常量

  • JavaScript 程序编码规范

    软件的长期价值直接源于其编码质量.在它的整个生命周期里,一个程序可能会被许多人阅读或修改.如果一个程序可以清晰的展现出它的结构和特征,那就能减少在以后对其进行修改时出错的可能性.编程规范可以帮助程序员们增加程序的健壮性. 所有的JavaScript代码都是暴露给公众的.所以我们更应该保证其质量.保持整洁很重要. JavaScript文件 JavaScript程序应独立保存在后缀名为.js的文件中. JavaScript代码不应该被包含在HTML文件中,除非这是段特定只属于此部分的代码.在HTML

  • JavaScript之编码规范 推荐

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

  • 5 种JavaScript编码规范

    什么是编码规范 编码规范就是指导如何编写和组织代码的一系列标准.通过阅读这些编码规范,你可以知道在各个公司里代码是如何编写的. 我们为什么需要编码规范 一个主要的原因是:每个人写代码的方式都是不同的.我可能喜欢这么写,而你喜欢用另一种方法写.如果我们只处理自己的代码,这样并没有什么问题.但如果有成千上万的程序员同时在一个代码库上面工作呢?如果没有规范,事情很快会变得一团糟.代码规范可以让新人迅速的熟悉相关的代码,并且也能写出让其他程序员简单易懂的代码. Airbnb JavaScript Sty

  • Javascript 编码约定(编码规范)

    1.使用 strict 模式 在一个作用域(包括函数作用域.全局作用域)中,可以使用 "use strict"; 来开启 strict 模式. 2.缩进 用 Tab 键进行代码缩进,以节约代码大小,使用4个空格的宽度来进行缩进(JSLint 建议). 3.符号 1) 大括号 与语句放同一行,放于最后面:仅有一行语句,也使用大括号: if (true) { //true } else { //false } while (true) { //alert(1); } 2) 空格 在逗号.分

  • 详解JS ES6编码规范

    1.块级作用域 1.1.let取代var ES6 提出了两个新的声明变量的命令: let 和const.其中,let可以完全取代var,因为两者语义相同,而且let没有副作用. var命令存在变量提升的特性,而let没有这个命令. 所谓变量提升,即指变量可以先使用,再声明,显然,这种编码规范非常不适合阅读. 1.2.全局常量和线程安全 在let和const之间,优先使用const. let应出现在单线程模块代码内,而const则非常适合多线程. // bad var a = 1, b = 2,

  • PHP编码规范的深入探讨

    缩进与空白字符(Indenting and Whitespace)使用 2 个空格而不使用 tab 键进行代码缩进(notepad++, Eclipse 等编辑器均支持此项配置);行尾不应该有空白字符应使用 \n (Unix换行符),而不是 \r\n (Windows 换行符)所有文件均应以一个空行结尾 运算符(Operators)所有二元运算符(二个值之间的运算符),如 +, -, =, !=, ==, > 等等,在运算符两端均需留有一个空格,如应该使用 $foo = $bar 而不是 $fo

  • 讲的非常不错的PHP编码规范第1/3页

    注:这是从PHPCMS开发文档里看到编码规范,虽名为PHPCMS的开发规范,但我觉得所有的PHP编程都该如此.写了那么多PHP,很多编码对照这规范都感觉欠缺很多,今后一定要对照纠正. Phpcms 编码规范 1. 引言-. 2 2. 适用范围-. 2 3. 标准化的重要性和好处-. 3 4. PHP编码规范与原则-. 3 4.1. 代码标记- 3 4.2. 注释- 3 4.3. 书写规则- 4 4.3.1. 缩进- 4 4.3.2. 大括号{}.if和switch. 4 4.3.3. 运算符.小

  • 浅谈Android编码规范及命名规范

    浅谈Android编码规范及命名规范

    前言: 目前工作负责两个医疗APP项目的开发,同时使用LeanCloud进行云端配合开发,完全单挑. 现大框架已经完成,正在进行细节模块上的开发 抽空总结一下Android项目的开发规范:1.编码规范 2.命名规范 注:个人经验,经供参考 一.Android编码规范 1.学会使用string.xml文件 在我看来,当一个文本信息出现的次数大于一次的时候就必须要使用string.xml 比如一个保存按钮 , 不规范写法: <Button android:id="@+id/editinfo_b

随机推荐