GO语言编码规范 | 青训营笔记

71 阅读2分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 1 天

今天学习了后端入门-Go语言原理和实践的5-8节

使用gofmt自动格式化代码,保证所有的Go代码与官方推荐格式保持一致
另外可以考虑qoimports,会对依赖包进行管理,自动增删依赖的包引用,按字母序排序分类,具体可以根据团队实际情况配置使用之所以将格式化放在第一条

注释:

  • 注释应该解释代码作用
  • 注释应该解释代码如何做的
  • 注释应该解释代码实现的原因
  • 注释应该解释代码什么情况会出错

编码规范-命名规范

  • 简洁胜于冗长
  • 缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写
  • 变量距离其被使用的地方越远,则需要携带越多的上下文信息

公共符号始终要注释

  • 包中声明的每个公共的符号变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何对库中的任何函数都必须进行注释

简单错误

  • 简单的错误指的是仅出现一次的错误,且在其他地方不需要捕获该错误优先使用 errors.New 来创建 匿名变量来直接表示简单错误如果有格式化的需求,使用 fmt.Errorf

错误判定

  • 判定一个错误是否为特定错误,使用 errors.Is
  • 不同于使用 ==,使用该方法可以判定错误链上的所有错误是否含有特定的错误
  • 在错误链上获取特定种类的错误,使用errors.As

panic

  • 不建议在业务代码中使用 panic调用函数不包含 recover 会造成程序崩若问题可以被屏蔽或解决,建议使用error 代替 panic
  • 当程序启动阶段发生不可逆转的错误时可以在 init 或 main 函数中使用 panic

recover

  • recover 只能在被 defer 的函数中使用
  • 嵌套无法生效
  • 只在当前 goroutine 生效
  • defer 的语句是后进先出

今天我了解到了工业代码的规范条件,对我以后的项目代码创作有很大帮助。