高质量编程丨 青训营笔记
这是我参与「第五届青训营」笔记创作活动的第4天。
一、本堂课重点内容
高质量编程这堂课主要讲解了在实际应用场景中，高质量的编程需要注意的一些编程原则和编码规范，使得代码能够达到正确可靠、简洁清晰、无性能隐患的目标，从而提升团队的编码效率，降低维护成本。
二、详细知识点介绍
1. 高质量编程
1.1 简介
什么是高质量？答：正确可靠、简洁清晰
- 各种边界条件是否考虑完备
- 异常情况处理，保证稳定性
- 易读易维护
编程原则：
- 简单性
- 可读性
- 生产力
如何编写高质量的 Go 代码
- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理
2. 编码规范
推荐使用 gofmt 自动格式化代码
注释
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
命名规范
- variable
- 简洁
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- function
- 简短
- 函数名不携带包名的上下文信息
- package
- 只由小写字母组成，不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息
- 不要与标准库重名
控制流程
- 避免嵌套，保持正常流程清晰
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
错误和异常处理
- 优先使用
errors.New来创建匿名变量直接表示简单错误 - 错误的 Wrap 和 Unwrap
- 判断一个错误是非为特定错误，使用
errors.Is - 在错误链上获取特定错误，使用
errors.As - 不建议在业务上使用 panic，当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用
- recover 只能在被 defer 的函数中使用
三、课后个人总结
学习这堂课后，发现了我在编码上存在的很多不规范的问题，有时候写出的代码过一段时间自己都看不懂了，不仅需要耗费大量的时间重新 review，还严重降低了自己的学习效率。从现在开始，需要时刻注意自己的编码习惯，写出更高效、更简洁的代码。
总的来说，这堂课对我的编程思想和技能都有了极大的提升，让我更加热爱Go语言，也更有信心编写高质量的代码。
