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


Posted in Javascript onJune 22, 2016

1.嵌入规则

Javascript程序应该尽量放在.js的文件中,需要调用的时候在页面中以<script src="filename.js">的形式包含进来。Javascript代码若不是该页面专用的,则应尽量避免在页面中直接编写Javascript代码。

2.对齐缩进与换行

a) 缩进

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

b) 换行

在以下位置必须换行:

每个独立语句结束后;

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

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

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

1).字符串过长截断

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

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

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

也可使用数组来进行拼接,相对+运算更容易调整缩进:

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

2).三元运算符过长

三元运算符由3部分组成,因此其换行应当根据每个部分的长度不同,形成3种不同的情况:

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

不得出现以下情况:

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

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

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

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

4).过长的JSON和数组

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

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

通过5个一组的分组,将每一行控制在合理的范围内,并且按逻辑进行了切分。 对于项目较多的数组,也可以采用相同的方法,如:

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

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

5).return语句

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

示例:

3.命名

命名的方法通常有以下几类:

a).命名法说明

1).camel命名法,形如thisIsAnApple

2).pascal命名法,形如ThisIsAnApple

3).下划线命名法,形如this_is_an_apple ·

4).中划线命名法,形如this-is-an-apple

根据不同类型的内容,必须严格采用如下的命名法:

b).变量名:必须使用camel命名法

c).参数名:必须使用camel命名法

d).函数名:必须使用camel命名法

e).方法/属性:必须使用camel命名法

f).私有(保护)成员:必须以下划线_开头

g).常量名:必须使用全部大写的下划线命名法,如IS_DEBUG_ENABLED

h).类名:必须使用pascal命名法

i).枚举名:必须使用pascal命名法

j).枚举的属性:必须使用全部大写的下划线命名法

k).命名空间:必须使用camel命名法

l).语义:命名同时还需要关注语义,如:

变量名应当使用名词;

boolean类型的应当使用is、has等起头,表示其类型;·

函数名应当用动宾短语;

类名应当用名词。

4.注释

注释要尽量简单,清晰明了。着重注释的意思,对不太直观的部分进行注解:

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

(当然这种直接定义一堆全局变量的做法不推荐)

此外,JavaScript 的注释有两种"//" 和"/* .... */",建议"//"用作代码行注释,"/* .... */"形式用作对整个代码段的注销,或较正式的声明中,如函数参数、功能、文件功能等的描述中:

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

另:复制粘贴应注意注释是否与代码对应。

5.声明

1).变量的声明

尽管 JavaScript 语言并不要求在变量使用前先对变量进行声明。但我们还是应该养成这个好习惯。这样可以比较容易的检测出那些未经声明的变量,避免其变为隐藏的全局变量,造成隐患。

在函数的开始应先用 var 关键字声明函数中要使用的局部变量,注释变量的功能及代表的含义,且应以字母顺序排序。每个变量单独占一行,以便添加注释。这是因为 JavaScript 中只有函数的 {} 表明作用域,用 var 关键字声明的局部变量只在函数内有效,而未经 var 声明的变量则被视为全局变量。示例:

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

用 var 声明过的变量 valueA 和没有声明的变量 valueB 是有区别的。特别需要注意的是,在函数内部用 var 声明的变量为局部变量,这样可以有效地避免因局部变量和全局变量同名而产生的错误。

2).函数的声明

函数也应在调用前进行声明,内部函数应在 var 声明内部变量的语句之后声明,可以清晰地表明内部变量和内部函数的作用域。

此外,函数名紧接左括号'('之间,而右括号')'和后面的'{'之间要有个空格,以清楚地显示函数名以其参数部分,和函数体的开始。若函数为匿名 / 无名函数,则 function 关键字和左括号'('之间要留空格,否则可能误认为该函数的函数名为 function。

内部函数声明示例:

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

从上例的输出可以看出,inF() 函数仅在 outF() 函数的内部生效,局部变量 innerA 对内部函数的作用域生效。这样的编码方式使得变量和函数的作用域变得清晰。

Javascript 相关文章推荐
Mootools 1.2教程 输入过滤第二部分(字符串)
Sep 15 Javascript
JS判断页面加载状态以及添加遮罩和缓冲动画的代码
Oct 11 Javascript
JavaScript中操作字符串之localeCompare()方法的使用
Jun 06 Javascript
jQuery实现类似老虎机滚动抽奖效果
Aug 06 Javascript
DWR中各种java方法的调用
May 04 Javascript
VUEJS实战之修复错误并且美化时间(2)
Jun 13 Javascript
javascript验证手机号和实现星号(*)代替实例
Aug 16 Javascript
如何在Angular2中使用jQuery及其插件的方法
Feb 09 Javascript
详解vue移动端日期选择组件
Feb 22 Javascript
vue elementUI tree树形控件获取父节点ID的实例
Sep 12 Javascript
atom-design(Vue.js移动端组件库)手势组件使用教程
May 16 Javascript
vue使用localStorage持久性存储实现评论列表
Apr 14 Vue.js
Javascript将数值转换为金额格式(分隔千分位和自动增加小数点)
Jun 22 #Javascript
Javascript将数字转化成为货币格式字符串
Jun 22 #Javascript
jQuery soColorPacker 网页拾色器
Jun 22 #Javascript
DIV+CSS+jQ实现省市联动可扩展
Jun 22 #Javascript
Javascript对象字面量的理解
Jun 22 #Javascript
Javascript闭包与函数柯里化浅析
Jun 22 #Javascript
JS中innerHTML和pasteHTML的区别实例分析
Jun 22 #Javascript
You might like
php 时间计算问题小结
2009/01/04 PHP
基于PHP实现通过照片获取ip地址
2016/04/26 PHP
PDO::getAvailableDrivers讲解
2019/01/28 PHP
js操作Xml(向服务器发送Xml,处理服务器返回的Xml)(IE下有效)
2009/01/30 Javascript
jquery插件制作 自增长输入框实现代码
2012/08/17 jQuery
固定网页背景图同时保持图片比例的思路代码
2013/08/15 Javascript
js图片预加载示例
2014/04/30 Javascript
JavaScript弹出窗口方法汇总
2014/08/12 Javascript
javascript的tab切换原理与效果实现方法
2015/01/10 Javascript
AngularJs学习第八篇 过滤器filter创建
2016/06/08 Javascript
微信QQ的二维码登录原理js代码解析
2016/06/23 Javascript
AngularJS 指令的交互详解及实例代码
2016/09/14 Javascript
js实现倒计时关键代码
2017/05/05 Javascript
vue实现全选、反选功能
2020/11/17 Javascript
nodejs开发微信小程序实现密码加密
2017/07/11 NodeJs
Vue多种方法实现表头和首列固定的示例代码
2018/02/02 Javascript
Node.js对MongoDB进行增删改查操作的实例代码
2019/04/18 Javascript
vue+element搭建后台小总结 el-dropdown下拉功能
2020/04/10 Javascript
解决vuecli3中img src 的引入问题
2020/08/04 Javascript
[49:43]VG vs FNATIC 2019国际邀请赛小组赛 BO2 第一场 8.15
2019/08/17 DOTA
python中django框架通过正则搜索页面上email地址的方法
2015/03/21 Python
简单介绍Python的轻便web框架Bottle
2015/04/08 Python
小白如何入门Python? 制作一个网站为例
2018/03/06 Python
浅谈python写入大量文件的问题
2018/11/09 Python
python getpass模块用法及实例详解
2019/10/07 Python
python3.8 微信发送服务器监控报警消息代码实现
2019/11/05 Python
关于Python字符编码与二进制不得不说的一些事
2020/10/04 Python
Python爬虫抓取论坛关键字过程解析
2020/10/19 Python
css3实现文字首尾衔接跑马灯的示例代码
2020/10/16 HTML / CSS
纯CSS3实现的井字棋游戏
2020/11/25 HTML / CSS
后勤工作职责
2013/12/22 职场文书
学员自我鉴定
2014/03/19 职场文书
圣诞节活动策划方案
2014/06/09 职场文书
幼儿园托班开学寄语(2015秋季)
2015/05/27 职场文书
HTML基础-标签分类(闭合标签,空标签,块级元素,行内元素,行级块元素,可替换元素)
2021/03/31 HTML / CSS
Spring Boot 整合 Apache Dubbo的示例代码
2021/07/04 Java/Android