4种增加JavaScript代码可读性实践

 

可读性高的代码可以定义为自解释的、易于人理解的、易于更改或扩展的代码。养成好的代码书写习惯尤为重要。

一、强类型检查

用===代替 ==可以增强检测。以为===要求数据和类型都相等,是绝对的相等,而==是只有数据相等,类型不一定相等。

二、变量命名

变量的命名要有语义,就是看到这个变量就知道其意思和用意。不要简写变量上下文。不要在变量名中添加额外的不需要的单词。 例如:

let floor_id = null;
let building_id = null;

//不要简写变量上下文,不好的事例:
let f_id = null;
let b_id = null;

//不要在变量名中添加额外的不需要的单词
let nameValue;


//正确
let name;

三、函数

函数名称应该是动词或短语,用以说明其背后的意图以及参数的意图。函数的名字应该说明他们做了什么,所以一般是使用长而具有描述性的名称。尽量一个函数应该只做一件事,不要在一个函数中执行多个操作。 函数尽量避免使用多参数,参数越少,测试函数就越容易,参数多的情况可以使用对象。 不要污染全局变量,如果需要扩展现有对象,请使用ES6类和继承,而不是在原生对象的原型链上创建函数。

例如:

settingTime() {
   this.settingTimeContainer=true;
}


//不要简写或者写些没有语义的函数名
time() {
   this.settingTimeContainer=true;
}

//原生对象的原型链上创建函数
Array.prototype.myFun = function myFun(){
...
}

//正确
class superArray extends Array{
myFun(){
...
}
}

四、 条件

使用条件简写,仅对布尔值使用此方法,确信该值不会是undefined 或null。 避免使用反面条件。

例如:

//避免使用反面条件
function isNotBlack(){
···
}
if(! isNotBlack){
···
}


//正确的例子

function isBlack(){
···
}
if(isBlack){
···
}

推荐阅读:

本文为博主原创文章,知识共享,开源精神,转载注明出处。