JavaScript:代码风格
JavaScript的弱类型和过度的容错并没有给程序质量带来编译时的保证,所以为了弥补,我们应该按照严格的规范编写代码。这有利于我们能够清晰地表达程序,以便于我们能够更加容易地理解它,修改它或修复它。
代码风格指的是在编码的一种表达方式。就相当于文字风格之于写作一样,好的文风更容易让我们理解代码。
间隔
空白是编程语法的一部分,空白不仅让我们更容易理解,同时也能避免语法错误
// bad
for(leti=0;i<10;i++){
}
上面的代码,是想实现一个循环,但是关键词 let 和变量 i 之间没有空格,导致语法错误
好的代码应当,如下所示
// good
for (let i = 0; i < 10; i++) {
}
上面的代码不仅关键词与变量之间存在空格,语句与语句之间也存在空间,for 循环的结构一目了然,也让人心情预约。
注释
注释的作用主要是表示语句或者函数的作用,毕竟有时代码和自然语言的转换并不是那么流畅。有时即便变量名按照语义化的标准定义可能仍然搞不懂是啥用处,这时注释的作用就体现出来。
在工作一段时间后,我发现注释的确有用,能够让你在一段时间后仍能看懂代码,十一不是刚过吗,开工时我就是看注释才逐渐回忆起项目的一些细节。
除了以上作用注释还起到整理思路的作用,在写代码之前往往先通过注释把主要的思路写完,然后再根据注释写代码,这样做能够发现思维的漏洞,并及时添加一些语句防止不必要的错误。这些注释也能为你日后优化代码起到帮助作用。
那么,如何使用注释?
JavaScript语言,提供行注释和块注释两种方式。
// 这是行注释
/*
这是块注释也叫多行注释
*/
一般来说,优先行注释,因为更加简单也不容易和正则表达式冲突,块注释通常用来描述文档,或函数使用。
语句
每行建议只写一条语句,如果语句过长可以拆分,通常在冒号或二元运算符后进行拆分,在换行的第二行进行缩进,一般两个空格,这样避免JavaScript自动补全冒号带来的bug,同时建议语句的结束添加分号
语句与语句之间如果没有关联可以空一行,如果某几行语句有关联建议放在一起,然后与其他没有关联的语句空一行
对于switch语句,建议避免使用case穿透,以防潜在的bug,而是在每一条case语句结束处都添加break,已终止当前case
对于带有 {} 语法的语句,建议不要省略 {} ,以防潜在的bug