这是我参加青训营的第4篇笔记

前言

主要介绍Go语言的高质量编码和语言编码规范

简介

什么是高质量？在编写代码时，能够达到正确可靠、简洁清晰的目标可称之为高质量代码。高质量代码需要满足的条件：

各种边界条件是否考虑完备异常情况处理周全、稳定性的保证代码易读易维护

编写高质量代码，团队之间相互阅读代码才会比较顺畅，同时也能提高团队开发效率。做到高质量代码，别人在看代码时才能清楚明白代码的作用，才能够放心的去重构或进行代码优化，才能放心的在原有代码基础之上增加新的功能，不用担心出现无法预料到的东西。

1: 代码格式:
推荐使用gofmt自动格式化代码
Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见IDE都支持方便的配置
goimports也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类。
2:注释
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简单的公共功能必须予以注释
- 无论长度或复杂成都如何，对库中的任何函数都必须进行注释
- 例外：不需要注释接线接口的方法。
怎样注释？
- 解释代码作用：适合注释公共符号，比如公共的常量、函数。如果一个函数通过名字就能知道他的作用，那么这样的函数可以不用加注释。
- 解释代码如何做的：适合注释实现过程，对一些实现逻辑复杂的代码、调用函数功能不是很明显的代码逻辑加上注释。
- 解释代码实现的原因：适合解析代码的外部因素，提供额外上下文，让人知道为什么这样做，要不然后续再维护代码时，会让人很难理解。
- 解释出错情况：适合解释代码的限制条件，通过注释可以知道在使用的过程中应该有哪些注意的点，以防在使用的过程中，产生错误。

命名规范的核心目标是降低阅读理解代码的成本，重点考虑上下文信息，设计简洁清晰的名称。

变量：
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  - 例如使用ServeHTTP而不是ServeHttp
  - 使用XMLHTTPRequest或者xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  - 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
函数
- 函数名不携带包名的上下文信息，因为包名和函数名总数成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息
包名：
- 只由小写字母组成，不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息，例如schema、task等
- 不要与标准库同名，例如不要使用sync、strings等
控制流程：
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进
  - 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

error尽可能提供简明的上下文信息链，方便定位问题，panic用于真正异常的情况，recover生效范围，在当前goroutine的被defer的函数中生效。

简单错误
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
错误的Wrap和Unwrap
- 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf中使用%w关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用errors.Is
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic