javascript编写规范
来源:互联网 发布:java编程工具哪个好 编辑:程序博客网 时间:2024/06/10 18:21
转载自:http://www.cnblogs.com/hustskyking/p/javascript-spec.html
前端编码规范之JavaScript
2013-08-14 23:55 by Barret Lee, 8585 阅读, 11 评论, 收藏, 编辑上次浅谈了下关于CSS的编码规范,大部分童鞋持赞同意见,仍存在一些童鞋不太理解这些规范的意义。
如果是个人或者小作坊开发,其实这些所谓的编码规范也没啥意思,因为大家写好的代码直接就给扔到网上去了,很少有打包、压缩、校检等过程,别人来修改你代码的情况也比较少。但是,对于一定规模的团队来说,这些东西还是挺有必要的!一个是保持代码的整洁美观,同时良好的代码编写格式和注释方式可以让后来者很快地了解你代码的大概思路,提高开发效率。
那么这次,继续抛砖引玉,说说Javascript一些需要引起注意的地方(这些东西也是团队开发的时候大家集思广益总结出来的)。
不规范写法举例
1. 句尾没有分号
2. 变量命名各种各样
3. if 缩写
4. 使用 eval
5. 变量未定义到处都是
6. 超长函数
7. ..........
书写不规范的代码让我们难以维护,有时候也让我们头疼。
(禁止)、(必须)等字眼,在这里只是表示强调,未严格要求。
前端规范之JavaScript
1. tab键用(必须)用四个空格代替
这个原因已经在前端编码规范之CSS说过了,不再赘述。
2. 每句代码后(必须)加";"
这个是要引起注意的,比如:
未加分号,结果被解析成
这是截然不同的两个结果,所以对于这个问题必须引起重视!!!
3. 变量、常量、类的命名按(必须)以下规则执行:
1) 变量:必须
采用骆驼峰
的命名且首字母小写
2) 常量:必须
采用全大写的命名,且单词以_
分割,常量通常用于ajax请求url,和一些不会改变的数据
3) 类:必须
采用骆驼峰
的命名且首字母大写,如:
4. 空格的使用
1)if
中的空格,先上例子
()
中的判断条件前后都(必须)
加空格()
里的判断前后(禁止)
加空格,如:正确的写法:if (isOk)
;不推荐的写法:if ( isOk )
2)switch
中的空格, 先上例子
3)for
中的空格,先上例子
for
后(必须)
加空格- 每个
;
后(必须)
加空格 ()
中禁止
用var
声明变量; 且变量的赋值=
前后(禁止)
加空格
4)function
中的空格, 先上例子
- 参数的反括号后(
必须)
加空格 function
后(必须)
加空格
5)var
中空格及定义,先上例子
- 声明变量
=
前后(必须)
添加空格 - 每个变量的赋值声明以
,
结束后(必须)
换行进行下一个变量赋值声明 (推荐)
将所有不需要进行赋值的变量声明放置最后一行,且变量之间不需要换行(推荐)
当一组变量声明完成后,空一行后编写其余代码
5. 在同一个函数内部,局部变量的声明必须
置于顶端
因为即使放到中间,js解析器也会提升至顶部(hosting)
推荐阅读:JavaScript-Scoping-and-Hoisting
6. 块内函数必须
用局部变量声明
引起的bug:第一种写法foo
的声明被提前了; 调用call
时:第一种写法会调用foo
函数,第二种写法不会调用foo
函数
注:不同浏览器解析不同,具体请移步汤姆大叔深入解析Javascript函数篇
7. (禁止)
使用eval,采取$.parseJSON
三个原因:
- 有注入风险,尤其是ajax返回数据
- 不方便debug
- 效率低,eval是一个执行效率很低的函数
建议:
使用new Function来代替eval的使用,最好就别用。
8. 除了三目运算,if
,else
等(禁止)
简写
9. (推荐)
在需要以{}
闭合的代码段前增加换行,如:for
if
换行可以是空行,也可以是注释
10. (推荐)
使用Function
进行类的定义,(不推荐)
继承,如需继承采用成熟的类库实现继承
平时咱们写代码,基本都是小程序,真心用不上什么继承,而且继承并不是JS的擅长的语言特性,尽量少用。如果非要使用的话,注意一点:
继承从原则上来讲,别改变他的构造函数,否则这个继承就显得很别扭了~
11. (推荐)
使用局部变量缓存反复查找的对象(包括但不限于全局变量、dom查询结果、作用域链较深的对象)
12. 当需要缓存this
时必须使用self
变量进行缓存
self是一个保留字,不过用它也没关系。在这里,看个人爱好吧,可以用_this, that, me等这些词,都行,但是团队开发的时候统一下比较好。
13. (不推荐)
超长函数, 当函数超过100行,就要想想是否能将函数拆为两个或多个函数
14. 等你来填坑~
小结
规范是死的,罗列这些东西,目的是为了让程序猿们对这些东西引起注意,平时写代码的时候注意格式,不仅仅方便了自己,也让其他阅读者看得舒服。
可能还有一些点没有涉及到,如果你有好的建议,请提出来,我们一起打造一个良好的前端生态环境!
- JavaScript 规范编写
- javascript编写规范
- javascript编写规范
- JavaScript编写规范
- javascript编写规范
- 浅谈JavaScript脚本编写规范
- JavaScript的google编写规范杂记Tips
- 编写可维护的javascript代码规范,简单整理
- javascript规范
- JavaScript规范
- JavaScript规范
- JavaScript规范
- javascript规范
- JavaScript规范
- javascript 规范
- JavaScript 规范
- JavaScript 规范
- C#代码编写规范
- node.js在本地启动https服务
- poi读取Excel时日期为数字 的解决方法
- TCP协议--TCP连接的建立和关闭
- 蚁族程序员自述:冬天盼暖气,面朝西二旗
- Qtablewidget设置某一列不可编辑
- javascript编写规范
- mysql中字符和数字在执行sql时进行类型转换
- BDTC 2017 | 中国大数据技术大会全日程和讲师曝光
- 拿什么拯救你,因硬盘故障丢失的数据!(内附恢复神器)
- 分布式Session解决方案
- XML
- Initialization of bean failed; nested exception is java.lang.NoSuchMethodError: org.objectweb.asm.Cl
- 关于使用cnzz统计出现广告的情况研究说明
- matlab中fix, floor, ceil, round 函数的使用方法