关于代码规范的那点事

215 阅读1分钟

好的命名应该是一看就知道类型是什么,干什么用的,比如说数字则是带有count、num等;布尔值应该带有is + 、has、 can*等;方法则是get、fetch、func;数组则是带有 list、 s

除此之外还有变量命名网站如 Codelf

优秀的 JS 代码规范

比如:对相同类型的变量使用相同的关键字

Bad:

getUserInfo(); 
getClientData(); 
getCustomerRecord();

Good:

getUser();

再比如:使用可搜索的命名

在开发过程中,我们阅读代码的时间会远远超过编写代码的时间,因此保证代码的可读性与可搜索会非常重要。

切记,没事不要坑自己。

Bad:

//525600到底啥意思?
for (var i = 0; i < 525600; i++) {
  runCronJob();
}

Good:

// 声明为全局变量
var MINUTES_IN_A_YEAR = 525600;
for (var i = 0; i < MINUTES_IN_A_YEAR; i++) {
  runCronJob();
}

github.com/ryanmcdermo…