01. 高质量编程
1.1 高质量编程简介
什么是高质量
- 编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则 实际应用场景千变万化.各种语言的特性和语法各不相同 但是高质量编程遵循的原则是相通的 简单性 消除"多余的复杂性".以简单清晰的逻辑编写代码 不理解的代码无法修复改进 可读性 代码是写给人看的，而不是机器 编写可维护代码的第一步是确保代码可读 生产力 团队整体工作效率非常重要
1.2 编码规范
如何编写高质量的Go代码
- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理
1.2.1 编码规范-代码格式
推荐使用gofmt自动格式化代码 gofmt Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格 常见IDE都支持方便的配置
goimports
也是Go语言官方提供的工具 实际等于gofmt加上依赖包管理 自动增删依赖的包引用、将依赖包按字母序排序并分类
1.2.2编码规范-注释
简介
- 注释应该做的
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
1. 注释应该解释代码作用 ●适合注释公共符号
2. 注释应该解释代码如何做的 适合注释实现过程
下面的只是说了是个循环，并没有额外的信息了，坏例子
3.注释应该解释代码实现的原因
适合解释代码的外部因素
提供额外上下文
4. 注释应该解释代码什么情况会出错 ●适合解释代码的限制条件
公共符号始终要注释
- 包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
-
有一个例外，不需要注释实现接口的方法。具体不要像下面这样做,他并没有给出具体的信息而是让我们去看其他的文档，是没用的
对于公共符号都有注释说明，尽管LimitedReader. Read本身没有注释，但它紧跟LimitedReader结构的声明，明确它的作用
小结 代码是最好的注释 注释应该提供代码未表达出的.上下文信息
1.2.3编码规范命名规范
variable 简洁胜于冗长 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写 例如使用ServeHTTP而不是ServeHttp 使用XMLHTTPRequest或者xmlHTTPRequest 变量距离其被使用的地方越远，则需要携带越多的上下文信息 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
variable
i和index的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对于程序的理解
将deadline替换成t降低了变量名的信息量 t常代指任意时间，deadline指截止时间，有特定的含义
function 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的 函数名尽量简短 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义 当名为foo的包某个函数返回类型T时(T 并不是Foo)，可以在函数名中加入类型信息
http包中创建服务的函数如何命名更好? func Serve(I net. Listener, handler Handler) error func ServeHTTP(I net. Listener, handler Handler) error
package 只由小写字母组成。不包含大写字母和下划线等字符 简短并包含一定的上下文信息。例如schema、task 等 不要与标准库同名。例如不要使用sync或者strings 以下规则尽量满足，以标准库包名为例 不使用常用变量名作为包名。例如使用bufio而不是buf 使用单数而不是复数。例如使用encoding而不是encodings 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短
小结 ●核心目标是降低阅读理解代码的成本 ●重点考虑上下文信息，设计简洁清晰的名称
1.2.4编码规范-控制流程
避免嵌套，保持正常流程清晰
如果两个分支中都包含return语句，则可以去除冗余的else
尽量保持正常代码路径为最小缩进 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
最常见的正常流程的路径被嵌套在两个if条件内 成功的退出条件是return nil,必须仔细匹配大括号来发现 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套
尽量保持正常代码路径为最小缩进
小结 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支 正常流程代码沿着屏幕向下移动 提升代码可维护性和可读性 故障问题大多出现在复杂的条件语句和循环语句中
