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

高质量编程

——编写的代码能够达到正确可靠、简洁清晰的目标可称为高质量代码

编码规范-注释

公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或者复杂程度如何，对库中的任何函数都必须进行注释
- 有一个例外，不需要注释实现接口的方法

如何编码高质量的Go代码

代码格式
- 推荐使用 gofmt 自动格式化代码
- gofmt：官方提供的工具，能自动格式化Go语言代码为官方统一的风格，常见IDE都支持方便的配置；
- goimports：也是Go语言官方提供的工具，实际上等于gofmt加上依赖包管理，自动增删依赖的包的引用、将依赖包按字母排序分类
注释
- 注释应该解释代码的作用
- 注释应该解释代码是如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况下会出错
命名规范
- variable
  - 简洁胜于冗长
  - 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    - 例如使用ServerHTTP而不是ServerHttp
    - 使用XMLHTTPRequest或者xmlHTTPRequest
  - 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    - 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出含义
- function
  - 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现
  - 函数名尽量简短
  - 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
  - 当名为foo的包某个函数返回类型T时（T不是Foo），可以在函数名中加入类型信息
- package
  - 只有小写字母组成，不包含大写字母和下划线等字符
  - 简短并包含一定的上下文信息。如schema，task等
  - 不要与标准库同名，例如不要用sync，strings
    尽量满足
  - 不使用常用变量作为包名，例如bufio而不是buf
  - 使用单数而不是负数，例如encoding而不是encodings
  - 谨慎地使用缩写，例如使用fmt在不破坏上下文的情况下比format更加简短
控制流程
- 避免嵌套，保持正常流程清晰
```
//Bad
if foo {
    return X
}else {
    return nil
}
//Good 
if foo {
    return X
}
return nil
```
  如果两个分支中都包含return语句，则可以去除冗余的else
- 尽量保持正常代码路径为最小缩进
  - 优先处理错误/特殊情况，尽早返回或继续循环来减少嵌套
- 错误和异常处理
  - 简单错误
    - 简单错误是指仅出现一次的错误，且在其他地方不需要捕获该错误。
    - 优先使用errors.New来创建匿名变量来直接表示简单错误。
    - 如果有格式化的需求，使用fmt.Errorf。
  - 错误的Wrap和，Unwrap
    - 错误的wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链。
    - 在fmt.Errorf中使用：%w关键字来将一个错误关联至错误链中。
  - 错误判定
    - 判定一个错误是否为特定错误，使用errors.ls。
    - 不同于使用==，使用该方法可以判定错误链上所有错误是否含有特定的错误。
    - 在错误链上获取特定种类的错误，使用errors.As.
  - panic
    - 不建议在业务代码中使用。
    - 调用函数不包括recover会造成程序崩溃
    - 若有问题可以被屏蔽或解决，建议使用error代替panic
    - 当程序启动阶段发生不可逆的错误时，可以在init或main函数中使用panic
  - recover
    - recover只能在被defer的函数中使用
    - 嵌套无法生效
    - 只在当前goroutine中生效
    - defer语句是后进先出的
    - 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈

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

高质量编程

——编写的代码能够达到正确可靠、简洁清晰的目标可称为高质量代码

编码规范-注释

如何编码高质量的Go代码