20条学习javascript的编程规范的建议


Posted in Javascript onNovember 28, 2014

1、使用js文件管理代码

所有代码尽量放在js文件中,然后再html文件中使用script引入,引入时注意放在body标签后面,并且不使用type或者language。

2、书写缩进

使用4个空白格缩进,注意不要使用tab键进行缩进。

3、断句

注意行长,每行不超过80个字符,超过时要进行适当断句,断句应该再操作符后面进行,最理想的是在逗号(,)后面进行断句,断句后下一行使用8格缩进。

4、注解

一般使用单行注释,块注释一般用于文档。

5、变量声明

所有变量使用之前先声明,未声明的变量会自动作为全局变量。全文应少使用全局变量。
最好把所有变量声明用一个var实现,并且每个声明单独放一行,并添加注释说明,如果可以所有声明变量按照字符顺序列出,如下:

var currentEntry,      //当前选择表项目

    level;          //缩进级别

在函数体内顶部定义所有变量,则var出现在函数体首行。

6、函数声明

所有函数使用前应该先声明,并且在变量之后进行-------有助于查看作用域。
函数名和括号直接不应该有空格;右括号(和函数参数之间不应该有空格;左括号)和函数体括号{之间有一个空格;函数体缩进4个空格;函数体结束括号}和函数声明关键字function首字符对齐。如下代码:

function outer(c,d) {

    var e = c * d;
    function inner(a,b) {

        return (e * a ) + b;

    }
    return inner(0,1);

}

函数和对象可以被放在任何允许放表达式的地方。
匿名函数关键字function和左括号(之间有一个空格。
尽量少使用全局函数。
对于立即执行函数,整个调用表达式应放在一对个括号()里面,以明确变量的值是函数执行结果而不是函数本身。如下代码:
var result = (function () {

    var key = "";

    return {

        get: function () {

            return key;

        },

        set: function (key) {

            key = key;

        }

    };

}());

7、命名

以字母、数字、下划线命名,避免使用国际字符、美元符号$、反斜杠\。
不要使用下划线作为名称的首位字符。
大多数变量和函数使用小写字母开头命名。
构造函数必须使用大写字母开头,在js中省略new不会报错(编译或者运行错误),但最好不要省略。
全局变量应用全部大写命名(js中没有宏和常量的概念)。

8、语句

简单语句

每行最多一条语句,并且使用分号;结尾,注意以函数字面量和对象字面量赋值的语句也要使用分号;。
js允许任何一个变量作为一条语句,但是在插入分号的时候可能会引起某些错误,因此一般使用表达式的语句是赋值或者函数调用语句(这句英文原文我大概理解了,但是不知道怎么翻译出来比较好)

复合语句(包含在一对{}之间的语句)

内部语句缩进4个空格。

左括号{应该在开始语句行的末尾。
右括号应该在最后单独一行,并且与左括号所在行的首字符对齐。
当语句在控制语句(例如for、if等)中时,应该使用花括号{}将语句包围起来,即使只有一条语句,这样可以保证在添加语句时不产生bug。

9、标签(这一部分的理解感觉不是很对)

要使用label的语句是有选择性的,只有下面几种:while、for、do、switch。

10、返回语句

返回的值应该用圆括号括起来,且返回表达式应该和return关键字在同一行(避免换行插入分号)。

11、if语句

遵循如下格式:

if (condition) {

    statements

}
if (condition) {

    statements

} else {

    statements

}
if (condition) {

    statements

} else if (condition) {

    statements

} else {

    statements

}

12、for语句

遵循如下格式:

for (initiliazation; condition; update) {

    statements

}
for (variable in object) {

    if (filter) {

        statements

    }

}

第一种循环格式用于数组和可以判断迭代次数的变量。
第二中用于对象遍历
注:此处提到了在对象原型中添加的属性是可以枚举的,因此要使用hasOwnProperty方法进行筛选,但是我用for in代码测试的时候,没有显示,这里不知道问题出在了哪里。

13、while语句

遵循如下格式:

while (condition) {

    statements

}

14、do-while语句

遵循如下格式:

do {

    statements  

} while (condition);

语句结尾要添加分号。

15、switch语句

遵循如下格式:

switch (expression) {

case expression:

    statements

default:

    statements

}

每一个case都要和switch对齐,避免过分缩进,只有case标签不是语句,应该不应该缩进。
每个case语句(除了default)必须要以break或return或throw结尾。

16、try语句

遵循如下格式:

try {

    statements

} catch (variable) {

    statements

}

try {

    statements

} catch (variable) {

    statements

} finally {

    statements

}

17、continue语句

避免使用continue语句。

18、with语句

不应该使用with语句。

19、空格使用

通过设置空行来分割逻辑相关的代码段,以增强代码可读性。
在以下情况下设置空格:
关键字之后跟随左括号(要使用空格,例如:
while (true) {
不能在函数参数和左括号(之间使用空格。
除了点号(.)、左圆括号(()、方括号([)以外的二元运算符都要使用一个空格来和操作数分割开。
除了typeof以外的一元操作符和他的操作数之间不应有空格。
for语句控制块()中每个分号;之后有一个空格。
每个逗号后面要有一个空格。

20、额外建议

[]和{}
当成员名称是连续整数时使用数组,当成员名称是任意字符串和名称时使用对象。
使用{}代替new object(),使用[]代替new Array()。
逗号,操作符
避免使用逗号,操作符(这一规定不适用于对象字面量、数组字面量定义和var声明语句以及参数列表)
块级作用域
除了符合语句不使用语句块,js没有块级作用域,只有函数作用域。
赋值表达式
while和if语句中条件判断部分避免使用赋值语句。
===和!==
判定相等使用全等符号(===和!==),避免使用强制类型相等转换符号(==和!=)。
若一个数字加(或者-)一个带有符号(+或者-)的数字,或者带有(++或--)的数字,则需要将带有符号或者(++或--)的数字括起来。
eval是恶魔(eval的滥用l)
eval有相同情况,不应使用Function构造函数,不向setTimeout或setInterval函数传递字符串。

以上20条建议都是本人在项目中总结出来的,对于新手学习javascript应该是小有帮助的,都是个人经验,难免有不全面的地方,如果发现了,还请告之,这里抛砖引玉,大家共同进步。

Javascript 相关文章推荐
学习ExtJS table布局
Oct 08 Javascript
javascript改变position值实现菜单滚动至顶部后固定
Jan 18 Javascript
JavaScript加强之自定义event事件
Sep 21 Javascript
关于Javascript作用域链的八点总结
Dec 06 Javascript
原生js的RSA和AES加密解密算法
Oct 08 Javascript
jquery.flot.js简单绘制折线图用法示例
Mar 13 Javascript
js 函数式编程学习笔记
Mar 25 Javascript
详解angularjs实现echart图表效果最简洁教程
Nov 29 Javascript
用ES6的class模仿Vue写一个双向绑定的示例代码
Apr 20 Javascript
Vue SPA单页应用首屏优化实践
Jun 28 Javascript
Jquery实现获取子元素的方法分析
Aug 24 jQuery
解决vue的router组件component在import时不能使用变量问题
Jul 26 Javascript
20个实用的JavaScript技巧分享
Nov 28 #Javascript
js获取浏览器基本信息大全
Nov 27 #Javascript
jQuery实现多按钮单击变色
Nov 27 #Javascript
jQuery的ready方法详解
Nov 27 #Javascript
javascript 面向对象封装与继承
Nov 27 #Javascript
javascript制作坦克大战全纪录(2)
Nov 27 #Javascript
javascript制作坦克大战全纪录(1)
Nov 27 #Javascript
You might like
php 判断服务器操作系统的类型
2014/02/17 PHP
解决cPanel无法安装php5.2.17
2014/06/22 PHP
运用jquery实现table单双行不同显示并能单行选中
2009/07/25 Javascript
JavaScript 保存数组到Cookie的代码
2010/04/14 Javascript
jQuery中focus事件用法实例
2014/12/26 Javascript
javascript实现tab响应式切换特效
2016/01/29 Javascript
浅谈jQuery animate easing的具体使用方法(推荐)
2016/06/17 Javascript
纯JavaScript 实现flappy bird小游戏实例代码
2016/09/27 Javascript
JavaScript实现公历转农历功能示例
2017/02/13 Javascript
基于Bootstrap下拉框插件bootstrap-select使用方法详解
2018/08/07 Javascript
koa+mongoose实现简单增删改查接口的示例代码
2019/05/13 Javascript
深入浅出了解Node.js Streams
2019/05/27 Javascript
vue实现在v-html的html字符串中绑定事件
2019/10/28 Javascript
微信小程序实现音频文件播放进度的实例代码
2020/03/02 Javascript
实现一个Vue自定义指令懒加载的方法示例
2020/06/04 Javascript
[56:45]DOTA2上海特级锦标赛D组小组赛#1 EG VS COL第一局
2016/02/28 DOTA
[00:37]2016完美“圣”典风云人物:rOtk宣传片
2016/12/09 DOTA
基于Python os模块常用命令介绍
2017/11/03 Python
Python实现的人工神经网络算法示例【基于反向传播算法】
2017/11/11 Python
Python读取Pickle文件信息并计算与当前时间间隔的方法分析
2019/01/30 Python
Django如何简单快速实现PUT、DELETE方法
2019/07/24 Python
Pytorch反向求导更新网络参数的方法
2019/08/17 Python
Django 实现xadmin后台菜单改为中文
2019/11/15 Python
python求绝对值的三种方法小结
2019/12/04 Python
python读取mysql数据绘制条形图
2020/03/25 Python
Pandas替换及部分替换(replace)实现流程详解
2020/10/12 Python
简述Html5 IphoneX 适配方法
2018/02/08 HTML / CSS
ONLY瑞典官网:世界知名服装品牌
2018/06/19 全球购物
玲玲的画教学反思
2014/02/04 职场文书
学校元旦晚会方案
2014/02/19 职场文书
新课培训心得体会
2014/09/03 职场文书
三严三实学习心得体会(精选N篇)
2016/01/05 职场文书
《雷雨》教学反思
2016/02/20 职场文书
2019年聘任书的写作格式及范文!
2019/07/03 职场文书
深入理解python多线程编程
2021/04/18 Python
Redis分布式锁Redlock的实现
2021/08/07 Redis