这是我在第五届字节后端青训营的第五篇笔记,笔记主体为:高质量编程与性能调优实战的前半节-高质量编程,字节青训营是一个很成熟的平台,学习内容很丰富。
高质量编程
简介
高质量编程体现:
- 各种边界条件是否考虑完备
- 异常情况处理,稳定性保证
- 易读易维护
编程原则:
- 简单性
-
消除“多余的复杂性”,以简单清晰的逻辑编写代码
-
不理解的代码无法修复改进
- 可读性
- 代码是写给人看的,而不是机器
- 编写可维护代码的第一步是确保代码可读
- 生产力
- 团队整体工作效率非常重要
编码规范
-
代码格式
-
注释
- 解释代码作用、实现方式和原因、什么情况下会出错
- 公共符号必须注释(包括变量、常量、函数以及结构)(接口方式不需要)
- 不明显也不简短的公共功能必须注释
- 无论长度和复杂度,库中任何函数都必须进行行注释
-
命名规范
- 简洁
- 缩略词大写
- 变量距离其被使用的地方越远,则需要携带越多的上下文信息
- package:只由小写字母组成,不包含大写和 '_';简短并包含上下文信息,且不与标准库同名
-
控制流程
- 避免嵌套
- 保持正常代码路径为最小缩进,优先处理错误情况/特殊情况
- 线性原理,处理逻辑尽量走直线,避免复杂的逻辑分支
-
错误和异常处理
- 具体为Go语言中错误处理的规范
性能优化建议
- 性能优化的前提是满足正确可靠、简洁清晰等质量因素
- 性能优化是综合评估,有时候时间效率和空间效率可能对立
- 避免常见的性能陷阱可以保证大部分程序的性能
- 普通应用代码,不要一味地追求程序的性能
- 越高级的性能优化手段越容易出现问题
- 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能
收获与思考
对于初学者来说很有帮助,理清思维,很nice