后端高质量编程 | 青训营笔记

60 阅读1分钟

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

课程重点内容

本堂课主要说了编程中代码的一些规范,这些规范在我们的项目中有很重要的作用。

编程原则

  • 简单性
  • 可读性
  • 生产力

编码规范

代码格式

注释

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

命名规范

  • 缩略词全大写,如果是开头就全小写
  • 距离被引用地方越远,需要携带越多上下文信息

控制流程

  • 避免嵌套
  • 保持代码路径为最小缩进

错误和异常处理

  • 简单错误
    • 优先使用 errors.New来创建匿名变量来直接表示简单错误
    • 如果需格式化,使用fmt.Errorf
  • Wrap和Unwrap:
    • Wrap实际上是提供了一个error嵌套另一个error
  • 错误判断:
    • 使用errors.Is ,特定错误 errors.As
  • panic
  • recover:
    • 只能在defer的函数中使用
    • 嵌套无法生效
    • 只在当前goroutine生效
    • defer的语句是后进先出