高质量编程及编码规范|青训营笔记
这是我参与[第五届青训营]伴学笔记创作活动的第2天，今天学习的是高质量编程及编码规范，首先提出一个问题
什么是高质量？
编写的代码能够达到正确可靠、简介清晰的目标即可称之为高质量代码，其编程原则有以下三点
- 简单性
- 可读性
- 生产力
高质量编程
Go语言的一些编码规范
注释：（应解释代码功能，不要写意义不明的注释）
1.包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释 2.任何既不明显也不简短的公共功能必须予以注释 3.无论长度或复杂程度如何，对库中的任何函数都必须进行注释
注释应解释:
- 代码是如何实现的
- 什么情况会出错
- 始终注释公共符号
- 应提供代码未表达出的上下文信息
代码格式
gofmt：Go原因呢官方提供的工具，能自动化格式Go院代码
变量命名
- 简洁
- 缩略词全大写（例如使用ServeHTTP而不是ServeHttp），但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
函数命名
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T并不是F00),可以在函数名中加入类型信息
包命名
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task等
- 不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用bufio而不是buf
- 使用单数而不是复数。例如使用encoding而不是encodings
- 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短
错误和异常
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
panic
- 不建议在业务中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
recover
- recover只能在被defer的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
小结
高质量的代码不仅能清晰明了地表达思路，也可以使项目性能得到一定的优化，故平时就养成习惯，遵守一些编码规范在工作中是十分重要的。
