这是我参与「第五届青训营 」笔记创作活动的第3天
高质量编程
- 编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
- 高质量的编程需要注意以下原则：简单性、可读性、生产力
常见编码规范
代码格式：使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致【提升可读性，风格一致的代码更容易维护，需要更少的学习成本、团队合作成本，同时可以降低 Review 成本】
注释：注释应该提供代码未表达出的上下文信息
-
注释应该解释代码作用：适合注释公共符号
-
注释应该解释代码如何做的：适合注释方法
-
注释应该解释代码实现的原因：解释代码的外部因素
-
注释应该解释代码什么情况会出错
-
公共符号始终要注释：包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
命名规范：关于命名的大多数规范核心在于考虑上下文
- variable
- 缩略词全大写，但当其位于变量开头且不需要导出时使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
- function
- 函数名不携带包名的上下文信息【因为包名和函数名总是成对出现的】
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
- package
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。eg: schema、task
- 不要与标准库同名。eg:不要使用 sync 或者 strings
控制流程：
- 避免嵌套，保持正常流程清晰
- 如果两个分支中都包含 return 语句，则可以去除冗余的 else
- 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性
错误和异常处理：
-
简单错误处理：优先使用 errors.New 来创建匿名变量来直接表示该错误【有格式化需求时使用 fmt.Errorf】
-
错误的 Wrap 和 Unwrap：在 fmt.Errorf 中使用 %w 关键字将一个错误 wrap 至其错误链中
-
错误判定：使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误 / 在错误链上获取特定种类的错误，使用 errors.As
-
panic 用于真正异常的情况
-
error 尽可能提供简明的上下文信息，方便定位问题
-
recover 生效范围，在当前 goroutine 的被 defer 的函数中生效
总结
自我感觉go的部分编码规范，与Java的相关规定存在类似的地方，但更多的也是根据go的特性存在独特的编码规范，使对应的工程更加规范。
