常见编码规范

💡 • 如果您使用vscode并安装Go扩展程序，我认为这甚至应该是默认设置。

公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或者复杂度如何，对库中的任何函数都必须进行注释
- 不过需要注释实现接口的方法（因为不知道接口的信息，知道方法也没用）
注释应该解释代码作用
- 适合注释公共符号
注释应该解释代码如何做的
- 适合注释方法，实现过程
注释应该解释代码实现的原因
- 解释代码的外部因素，提供额外的上下文
注释应该解释代码什么情况会出错

总结

variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  - 例如ServeHTTP而不是ServeHttp
  - 使用XMLHTTPReqest或者xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
- 将deadline替换成t降低了变量名的信息量
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
package
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
还有一些需要尽量满足的（以标准库包名为例）
- 不适用常用的变量名作为包名，比如用bufio而不是buf
- 使用单数而不是复数
- 谨慎使用缩写

总结

总结

简单错误处理
- 简单错误指只出现一次的错误，并且在其他地方不需要捕获
- 优先使用 errors.New 来创建匿名变量来直接表示该错误。有格式化需求时使用 fmt.Errorf
错误的 Wrap 和 Unwrap
- 错误的wrap指提供了一个error嵌套另一个error，从而生成一个错误的跟踪链
- 在 fmt.Errorf 中使用 %w 关键字来将一个错误 wrap 至其错误链中
- Go1.13 在 errors 中新增了三个新 API 和一个新的 format 关键字，分别是 errors.Is、errors.As 、errors.Unwrap 以及 fmt.Errorf 的 %w。如果项目运行在小于 Go1.13 的版本中，导入 golang.org/x/xerrors 来使用。以下语法均已 Go1.13 作为标准。
错误判定
- 使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误。
- 在错误链上获取特定种类的错误，使用 errors.As
panic
- 不建议在业务代码中使用 panic
- 如果当前 goroutine 中所有 deferred 函数都不包含 recover 就会造成整个程序崩溃
- 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
recover
- recover 只能在被 defer 的函数中使用，嵌套无法生效，只在当前 goroutine 生效
- 如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈。

总结

Go语言常见的编码规范 | 青训营笔记