如何写出高质量和性能好的GO代码

什么是高质量：

1. 编写的代码能够达到正确可靠、简洁清晰的目标可叫做高质量代码。
2. 各种边界条件是否考虑完备。
3. 异常情况处理，稳定性保证。
4. 易读易维护。

编程原则：

1. 实际应用场景多种多样，各种语言的特性和语法各有不同，但是高质量编程遵循的原则是相通的。
2. 简单性：

• 消除“多余的复杂性”，以简单清晰的逻辑编写代码。
• 不理解的代码无法修复改进。

3. 可读性：

• 代码是给人看的，而不是机器。
• 编写可维护代码的第一步是确保代码可读。

4.生产力

• 团队整体工作效率非常重要。

编码规范

如何编写高质量的Go代码

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

公共符号始终要注释

• 包中声明的每个公共的符号：变量、常量、函数以及结构都要添加注释
• 任何既不明显也不简短的公共功能必须加注释。
• 无论长度或复杂程度如何，对库中的任何函数都必须进行注释。

注释应该做的

• 注释应该解释代码的作用

• 注释应该解释代码如何做的

• 注释应该解释代码实现的原因、提供额外的上下文

• 注释应该解释代码什么情况会出错，适合解释代码的限制条件

命名规范

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  • 例如使用ServeHTTP而不是ServeHttp
  • 使用XMLHTTPRequest或者xmlHTTPRequest
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同的地方可以轻易辨认出其含义。 funtion
• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
• 函数名尽量简短
• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息。

性能优化建议

• 性能优化的前提时满足可靠、简洁清晰等质量因素
• 性能优化是综合评估，有时候时间效率和空间效率可能对立。
• 在Go语言中可以使用Benchmark，Go语言提供了支持基准性能测试的benchmark工具 go test -bench=. -benchmen 命令
• slice 预分配内存