FED实验室 - 专注WEB端开发和用户体验

前端Code规范之JS

SPECIFICATION 煦涵 2736℃ 0评论

一、缩进,分号,单行长度
1.缩进一律使用2个空格
2.Statement 结束一律以分号结束, 不可以省略
3.单行长度,理论上不要超过80列,不过如果编辑器开启 soft wrap 的话可以不考虑单行长度,如果需要换行,存在操作符的情况,一定在操作符后换行,然后换的行缩进4个空格。

二、添加空行
1.方法之间添加
2.单行或多行注释前添加
3.逻辑块之间添加空行增加可读性

三、变量
1.标准变量采用驼峰标识
2.使用的ID的地方一定全大写
3.使用的URL的地方一定全大写, 比如说 reportURL
4.常量采用大写字母,下划线连接的方式
5.构造函数,大写第一个字母
6.所有函数内变量声明放在函数内头部,只使用一个var,一个变量一行,在行末跟注释说明。

四、函数
1.一定先声明再使用。
2.函数表达式和函数声明
3.函数调用括号前后不需要空格
4.立即执行函数的写法, 最外层必须包一层括号
5.
"use strict"决不允许全局使用,必须放在函数的第一行,可以用自执行函数包含大的代码段, 如果 "use strict" 在函数外使用, JSLint 和 JSHint 均会报错
6.自定义函数添加文档注释

五、if/else switch for语句
1.大括号前留一个空格
2.switch中case对齐
3.单条if语句建议加大括号

六、注释
1.当行注释:

//我是单行注释

2.多行注释

/**
 * 我是多行注释
 */

3.文档注释

/**
 * [methods description]
 * @param  {[type]} param01 [description]
 * @param  {[type]} param02 [description]
 * @return {[type]}         [description]
 */

适合于所有的自定义函数、构造函数及所有对象的方法

下面是「FED实验室」的微信公众号二维码,欢迎扫描关注:

FED实验室

行文不易,如有帮助,欢迎打赏!

赞赏支持or喜欢 (0)or分享 (0)
捐赠共勉
发表我的评论
取消评论

表情

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址