这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
本堂课重点内容
高质量编程
详细知识点介绍
高质量编程
编程原则
1.简单性
2.可读性
3.生产力
如何编写高质量的Go代码
1.代码格式
2.注释
3.命名规范
4.控制流程
5.错误和异常处理
公共符号要始终注释
1.包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
2.任何既不明显也不简短的公共功能必须予以注释
3.无论长度或复杂程度如何，对库中的任何函数都必须进行注释
4.有一个例外，不需要注释实现接口的方法
推荐使用gofmt自动格式化代码
1.gofmt
2.goimports(自动增删依赖的包引用、将依赖包按字母序排序并分类)
注释
好的代码有很多注释，坏代码需要很多注释
注释应该做的：
1.注释应该解释代码作用
2.注释应该解释代码如何做的
3.注释应该解释代码实现的原因
4.注释应该解释代码什么情况会出错
命名规范
1.间接胜于冗长
2.缩略词全大写，当其处于变量开头且不需要导出时，使用全小写
3.函数名不携带包名的上下文，因为包名和函数名总是成对出现
4.函数名尽量简短
5.包名只有小写字母组成
控制流程
1.避免嵌套，保持正常流程清晰
2.尽量保持正常代码路径为最小缩进
错误和异常
错误的Wrap和Unwrap
1.错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
2.在fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中
总结
上述总结写出了高质量Go代码需要注意的东西。
