高质量编程简介及编码规范（1）
1、什么是高质量 ------------编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
简介：
简单性：
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法恢复改进 可读性：
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保可读 生产力：
- 团队整体工作效率非常重要 规范编码； & 代码格式 & 注释 & 命名规范 & 控制流程 & 错误和异常处理
注释应改做的 & 注释应该揭示代码作用
& 注释应该解释代码如何做的
& 注释应该解释代码实现的原因
& 注释应该解释代码什么情况会出错
小结：
代码是最好的注释
注释应该提供代码末表达出的上下文信息
命名规范 & 简洁胜于冗长 & 缩写词全大写，但当其位于变量开头且不需要导出时，使用全小写 * 例如使用ServeHTTP而不是ServeHttp * 使用XMLHTTPRequest或者xmlHTTPRequest & 变量距离其被使用的地方越远，则需要携带越多的上下文信息 * 全局变量在其名字中需要更多的上下文信息，是的在不同地方可以轻易辨认出其含义
//Bad for index := 0; index < len(s); index++{ //do something i和index的作用区域范围仅限于for 循环内部时 index 的额外冗余几乎没有增加对于程序的理解 } //Good for i := 0; i < len(s); i++{ //do something }
function & 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的 & 函数名尽量简短 & 当名为foo 的包某个函数返回类型 Foo时，可以省略类型信息而不导致歧义 & 当名为foo 的包某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息
Package & 只由小写字母组成。不包含大写字母和下划线等字符 & 简短并包含一定的上下文信息。例如：sehema 、task等 & 不要与标准库同名。例如:不要使用sync或者strings
以下规则尽量满足，以标准库库包名为例 & 不使用常用变量名作为包名。例如：使用bufio而不是buf & 使用单数而不是复数。例如：使用eencoding而不是encodings & 谨慎地使用缩写。例如：使用fmt在不破坏上下文的情况下比format更加简短
小结 & 核心目标是降低阅读理解代码的成本 & 重点考虑上下文信息，设计简洁清晰的名称
避免嵌套，保持正常流程清晰 //Bad if foo { return x 如果两个分支中都包含return 语句，则可以去除冗余的else } else { return all }
//Good if foo { return x } retrun null
尽量保持正常代码路径为最小缩进 & 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套 & 最常见的正常流程的路劲被嵌套在两个 if 条件内 & 成功的退出条件是 return nil，必须仔细匹配大括号来发现 & 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误 & 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套 //Bad func OneFunc() error {
err := doSomething() if err == nil { err := doAnotherThing() if err == nil { return nil //normal case } return err } return err }
小结 & 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支 & 正常流程代码沿着屏幕向下移动 & 提升代码课维护性和可读性 & 故障问题大多出现在复杂的条件语句和循环语句中
