JavaScript_代码规范

原文链接

设计原则：

1.原子思想：即每个function就做一件事；

2.归纳思想：将同一类的操作，全部整合到一起；

3.方便维护：可以便于后来人进行快速维护；

4.方便拓展：即可以根据每个不同的项目进行不同的更改；

5.通用前端设计模式：一些前端可以通用的设计模式

6.注意写好注释，将注释写的具体点；

JavaScript 代码规范

代码规范通常包括以下几个方面:

变量和函数的命名规则

空格，缩进，注释的使用规则

其他常用规范……

规范的代码可以更易于阅读与维护

代码规范一般在开发前规定，可以跟你的团队成员来协商设置

变量名

变量名推荐使用驼峰法来命名(camelCase):

firstName = "John";
lastName = "Doe";

前缀规范：

每个局部变量都需要有一个类型前缀，按照类型可以分为：

s：表示字符串。例如：sName，sHtml；

n：表示数字。例如：nPage，nTotal；

b：表示逻辑。例如：bChecked，bHasLogin；

a：表示数组。例如：aList，aGroup；

r：表示正则表达式。例如：rDomain，rEmail；

f：表示函数。例如：fGetHtml，fInit；

o：表示以上未涉及到的其他对象，例如：oButton，oDate；

g：表示全局变量，例如：gUserName，gLoginTime

空格与运算符

通常运算符 ( = + - * / ) 前后需要添加空格:

var x = y + z;
var values = ["Volvo", "Saab", "Fiat"];

代码缩进与换行

缩进

在同一系统中应采用同一种缩进标准，本文提倡缩进大小为4个空格。各编译器对Tab键所代替的空白大小定义不同。建议在设置开发环境时，将编辑器里的Tab快捷键重新设置成4个空格。多数编译器提供了此功能。否则建议按4次空格来进行缩进。

换行

在以下位置必须换行：

每个独立语句结束后；

if、else、catch、finally、while等关键字前；

运算符处换行时，运算符必须在新行的行首

对于因为单行长度超过限制时产生的换行，参考行长度中的策略进行分隔

1).字符串过长截断

每行代码应小于80个字符。若代码较长应尽量换行，换行应选择在操作符和标点符号之后，最好是在分号“;”或逗号“,”之后。下一行代码相对上一行缩进4个空格。这样可以有效防止复制粘贴引起的代码缺失等错误并增强可读性

按一定长度截断字符串，并使用+运算符进行连接。分隔字符串尽量按语义进行，如不要在一个完整的名词中间断开。特别的，对于HTML片段的拼接，通过缩进，保持和HTML相同的结构：

2).三元运算符过长

三元运算符由3部分组成，因此其换行应当根据每个部分的长度不同

3).过长的逻辑条件组合

当因为较复杂的逻辑条件组合导致80个字符无法满足需求时，应当将每个条件独立一行，逻辑运算符放置在行首进行分隔，或将部分逻辑按逻辑组合进行分隔。最终将右括号)与左大括号{放在独立一行，保证与if内语句块能容易视觉辨识。

4).过长的JSON和数组

如果对象属性较多导致每个属性一行占用空间过大，可以按语义或逻辑进行分组的组织

5).return语句

return如果用表达式的执行作为返回值，请把表达式和 return 放在同一行中，以免换行符被误解析为语句的结束而引起返回错误。return 关键字后若没有返回表达式，则返回 undefined。构造器的默认返回值为 this。

转载于:https://my.oschina.net/u/3462387/blog/912759