大前端JS代码规范

1、基本的格式化

1、1 缩进层级
使用tab键进行缩进
1、2 语句结尾
一定要加上分号——与eslint不符合,二选一,项目要统一
1、3 行的长度
尽量保证在宽度1300的屏幕上的sublime编辑器中不折行
1、5 空行
  • 方法之间
  • 局部变量与第一条语句之间
  • 方法内的逻辑片段之间
  • 空行不超过两行
1、6 命名

变量与函数

命名采用小驼峰命名法则

变量尽量语义化:
数字:count、length、size
字符串:name、title、message

循环变量:i、j、k

函数第一个单词应当是动词

  • hasUserPrase 判断使用,返回布尔值
  • isChineseName 判断使用,返回布尔值
  • getCommentList 获取使用, 返回列表
  • set 用于保存
  • addName 添加使用
  • updName 修改使用
  • delObj 删除使用
    常量
  • 全部大写,用_来分割比较长的单词
    构造函数
  • 首字母大写的驼峰写法
1、7 直接量
均使用直接定义的方法,避免使用`new Array()`之类的方法

2、注释

一定要写注释,单个文件要写注释,单个方法要写注释,
复杂的或者重要的逻辑代码需要写注释

要使用sublimedocblockr辅助插件来写注释

文件注释:

1
2
3
4
5
/*
* @description 这个类的描述
* @author 赵盛迪
* @time 2016-2-19
*/

2、1 单行注释
如果补在代码行后面的话,尽量不超过屏幕宽度
2、2 多行注释
注释需要对齐
2、3 注意场景
* 容易复用的插件、代码块需要写注释
* 逻辑复杂,容易遗忘的代码,需要写注释
分享
返回顶部