高质量编程与编码规范

这是我参与【第五届青训营】伴学笔记创作活动的第三天

高质量：编写的代码能够达到准确可靠、简洁清晰的目标（各种边界条件是否完备、异常情况处理，稳定性保证、易读易维护）

编程原则：消除“多余的复杂性”，以简单清晰的逻辑编写代码，编写易读的代码，团队工作效率很重要。

注释

代码写的怎么样，

• 注释很重要：公共符号始终要注释：库中函数、公共功能需要注释（不需要注释接口）
• 代码格式不能少： gofmt自动格式化Go语言，goimports依赖管理

注释是大头：

• 解释代码如何做的
• 解释代码实现的原因
• 解释代码什么情况下会出错
• 公共符号始终要注释

命名规范

• 变量

简洁胜于冗长

缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

变量距离其被使用的地方越远，则其需要携带越多的上下文信息

• 函数名

函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的

函数名尽量简短

当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义

当名为foo的包某个函数返回类型T时（非Foo），可以在函数名中加入类型信息

• 包

只有小写字母组成，不包含大写字母和下划线等字符

简短并包含一定的上下文信息

不要与标准库同名

错误与异常处理

• 简单错误

简单错误指只出现一次的错误，且在其他地方不需要捕获该错误

优先使用errors.New来创建匿名变量直接表示简单错误

如果有格式化的需求，使用fmt.Errorf

• 错误的Wrap和Unwrap

错误的Wrap实际上是提供一个error嵌套另一个error的能力，从而生成一个error的跟踪链

在fmt.Errorf中使用：%w 关键字来将一个错误关联至错误链中

• 错误判断

判定一个错误是否为特定错误，使用error.ls

不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误。

• panic

不建议在业务代码中使用panic

调用函数不包含recover会造成程序崩溃

若问题可以被屏蔽或解决，建议使用eror代替panic

当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

• recover

recover只能在被defer的函数中使用

嵌套无法使用

只在当前goroutine生效

defer的语句总是后进先出