丁鹿学堂:前端高质量代码注意事项

77 阅读2分钟
js代码的可读性

我们常说好的代码除了注意健壮性之外,还要注意可读性。写好可读性的代码,不仅自己便于维护,同事之间交接或者修改复用都是很方便的。

雷军曾经也是一个很厉害的程序员,别人就夸他的代码写的像诗一样。

这也是对我们代码可读性的最高赞美了。

那什么样的代码是可读性高的代码呢?

代码结构清晰。别人能够看懂你的意思。

怎么写出可读性高的代码

1.注意优化代码结构

避免if-else分支过长。解决:使用策略模式去优化。

避免分支嵌套,不要if嵌套if,或者if-else再嵌套if。解决:通过代码的& 和|| 去把多个判断条件写在一起,用联合逻辑代替分支嵌套

避免回调地狱。这个也要注意,函数不要过多的嵌套形成回掉地狱。这个很多人知道,用promise或者async 和await去解决。

2.遵循命名规范

注意一些约定俗成的命名规范,可以让代码更容易看懂。

比如,常量用大写,类名首字母大写,普通的变量在语义化的情况下使用小驼峰命名法。

3.写好注释

注释不是越多越好,也不是越少越好。通常不同的开发团队都有不同的注释规范。我们不缺规范,缺的是平时坚持去按照规范写注释。 因为在开发过程中,可能比较赶时间,或者觉得这些完全能够看懂而不写。这些都是要去避免的。

js代码的可复用性

高质量的代码的可复用性是比较强的。

注意点有两个,一个是粒度尽量小, 在需要的时候可以拿过去用。第二就是减少重复,重复的代码不写第二遍。只要发现代码重复了,就抽象成一个函数去复用。做到低耦合,高内聚。

js代码的可扩展性

写代码还要注意可扩展性。这个在写当前代码的时候就要多考虑一步,如果以后涉及到代码修改,可以做到不用大规模改动。

比如,当增加新需求的时候,不用变动现有结构。或者写新功能的时候只增加新代码而不去改动老代码。