Skip to main content

改名

变量/函数改名

无论是变量命名,还是函数命名,都要尽量让别人明白你这个变量/函数是干什么的。变量命名的规则着重于描述“是什么”,函数命名的规则着重于描述“做什么”。

变量

const a = width \* height

上面这个变量就不太好,a 很难让人看出来它是什么。

const area = width \* height

改成这样就很好理解了,原来这个变量是表示面积。

函数

function cache(data) {
const result = [];
data.forEach((item) => {
if (item.isCache) {
result.push(item);
}
});

return result;
}

这个函数名称会让人很疑惑,cache 代表什么?是设置缓存还是删除缓存?再一细看代码,噢,原来是获取缓存数据。所以这个函数名称改成 getCache() 更加合适。