编写可维护的javascript - 基本格式化

由于新公司前期比较忙,之前也没时间学习新东西,但是目前感觉代码写的还是不够规范,所以也是花时间学习如何书写规范的代码,js/css/公共代码的书写。

  • 缩进层级:使用制表符进行缩进(制表符可以进行设置4个或者2个)
  • 语句必须使用分号进行结尾
  • 代码长度不超过80个字符
  • 换行:通常会在运算符(避免ASI自动插入分号的问题)后面进行换行,下一行避免增加两个层级的缩进。变量赋值除外,变量赋值的下一行要与赋值运算符的位置保持一致。

流程判断语句的前后(if/switch/for/while)

方法之间

变量与第一条语句之间

注释之前

逻辑代码片段划分

单文件引入不同类型文件之间(node_module/公共组件/业务组件/功能方法/枚举/css相关文件)

  • 命名:

采用小驼峰大小写

变量名以名词开头,函数/方法名以动词开头(can/has/is/get/set)

  • 常量

书写采用大写字母加下划线链接的方式

常量提取到公共文件当中去

代码的数字量需要提取到公共枚举文件并且创建对应的常量(另一种方式,数字量后面添加对应注释说明)

  • 构造函数

首字母大写

调用前必须使用new

  • 字符串

采用双引号

多行字符串使用"+"链接

同行字符串链接ES6建议使用模板字符换

  • 数字:不允许出现省略整数或者小数部分
  • null:对于null最好的理解是将其理解为对象的占位符

不要使用null检测传入的某个参数

不要使用null进行未初始化的变量(后面谈到判空的时候会讲解)

  • undefined

避免在代码中使用undefined

undefined === null // true

创建的变量在未赋值之前,将其赋值为null,因为typeof null返回object,typeof undefined返回undefined,可以区分开

  • 对象字面量:使用对象字面量创建对象。
  • 数组直接量:使用数组直接量创建数组。

 

你可能感兴趣的:(编写可维护的javascript - 基本格式化)