一个的程序员应该要求自己尽量写出好代码,众所周知,好的代码应该符合逻辑清晰,易于维护,整洁简单,性能优化等优点。而完全与之相反的就是我们所说的烂代码。那么,我们应该如何避免写出烂代码呢?本文将为大家总结出十条避坑准则,希望可以帮助程序员们写出更加优美简洁的代码。
1、不要混合不同的格式
程序员在写代码时要注意不要混合不同的格式,例如单引号或双引号就不能混用。尤其是在它们的语义相同的时候,也千万不能混用。
2、不要把代码写成一行
3、不要忽视发现的错误
错误也是一种逻辑分支,如果不处理的话,代码就不够健壮。前端代码处理错误的方式一般为提示用户有异常发生。如果错误不影响业务流程,则写入日志里并上报。因此关于错误的正确处理态度是,当你发现某些错误时,需要让其他人也了解它,因此需要打印出日志或 Traceback。
4、代码需要做特定测试
测试的重要性这里就不在赘述了,大家千万别以为测试仅仅只是重复且无意义的工作。毕竟通过测试我们才能发现许多的问题。
5、不要使用除英语外的语言注释
注释是程序很重要的部分,可以说是理解一个工程或项目的途径之一。注释的重要性大家都知道,但是写注释的时候,一定要注意不要使用除英语外的其他语言。
6、不考虑业务模型
现在都是敏捷开发,导致程序员也变得浮躁了,不分析或者草率分析需求,拿到就是干,随着业务迭代,开发人员增加,每个人各写一套,关于一个名词的定义都能有好几套写法,sql查询可能会分散到好多repo中,相同的sql可能会在不同的地方写上好几遍。关键是发现之前的模型定义错了,数据库的ER图设计有问题,仍然不会去更改,因为总是有新的需求会来,然后拼了命的做需求,留下一堆烂代码无法维护,最后连自己都不想看。
7、不要使用陈旧的 API
陈旧的 API 往往有很多问题,比如安全、性能、不易读等。
Array.isArray(array)
array.find(a => a % 2 === 0);
Object.keys(obj).forEach(console.log)
'some text'.includes('some')
' some text '.trim()const array = [];const obj = {};
8、不要用字符串拼接url
字符串拼接 url 需要处理 encode 或者 decode 的情况,还有对于 ?和 # 的判断不对的话,很容易造成漏洞或者 Bug。目前浏览器和 Node 都已经提供了标准的 URL 解析方法。
9、if 条件逻辑嵌套不要超过三层
避免这么做的道理很简单,过深的嵌套会导致理解困难。因此解决办法就是合并判断条件,或者独立成函数。
if (status = Opened && type = 'array' &&code = Success) {
doSomething();
}
10、避免重复
几乎所有程序员都知道要避免拷代码,但是拷代码这个现象还是不可避免的成为了程序可维护性的杀手。无论何种重复,都在一定程度上说明了程序员的水平有问题。另外,除了代码重复之外,很多热衷于维护代码质量的程序员新人很容易出现信息重复。随着项目的演进,无用的信息会越积越多,最终甚至让人无法分辨哪些信息是有效的,哪些是无效的。
免费提供问答解答,帮您轻松解决难题
申请免费试听
只要一个电话
我们为您免费回电