这是我参与「第五届青训营 」伴学笔记创作活动的第 5 天
高质量编程
如何写出更简洁清晰的代码,在工作中,编程式团队合作的工程,好的代码让其他人更容易在你的基础上开发,同时出问题的概率更低,大家更乐于与你工作,也让团队更高效,另外在面试的时候,也有编码环节,能不能用代码清晰的表达出你的思路,让面试官额外加分。
什么是高质量
正确性:是否考虑各种边界条件,错误的调用是否能够处理
可靠性:异常情况或者错误的处理策略是否明确,以来的服务出现异常是否能够处理
简洁:逻辑是否简单,后续调整功能或新增功能是否能够快速支持
清晰:其他人在阅读理解代码的时候是否能清楚明白,重构或者修改功能是否不会担心出现无法预料的问题
编程原则
如何编写高质量的代码,实际应用场景千变万化,各种语言的特性和语法各不相同,有哪些通用的原则吗?
简单性:消除多余的复杂性,以简单清晰的逻辑编写代码。在实际工程项目中,复杂的程序逻辑会让人害怕重构和优化,因为无法明确预知调整造成的影响范围,难以理解的逻辑,排查问题时也难以定位,不知道如何修复
可读性:可读性很重要,因为代码是写给人看的,而不是机器在项目不断迭代的过程中,大部分工作是对已有功能的完善或扩展,很少会完全下线某个功能,对应的功能代码实际会生存很长时间。已上线的代码在其生命周期内会被不同的人阅读几十上百次
生产力:编程在当前更多是团队合作,因此团队整体的工作效率是非常重要的一方面。为了降低新成员上手项目代码的成本,Go语言甚至通过工具强制统一所有代码格式。编码在整个项目开发链路中的一个节点,遵循规范,避免常见缺陷的代码能够降低后续联调、测试、验证、上线等各个节点出现问题的概率,就算出现问题也能快速排查定位