高质量编程简介及编码规范|青训营笔记

在本次课程的学习过程中，我将收获

如何编写出简洁而又清晰的代码
go语言程序的常用优化手段
熟悉并掌握go语言的性能分析工具
了解工程中性能优化的原则和流程

在高质量编程方面，需要考虑的问题有很多，比如各种边界条件是否考虑完备、异常情况该如何处理，并保证其稳定性、以及代码的易读易维护。在编程原则方面主要有以下几个特点：

简单性：消除“多余的复杂性”
可读性：编写可维护代码的第一步是确保代码可读
生产力：团队整体工作效率非常重要关于如何编写高质量的代码，可以参考以下建议：

推荐使用 gofmt 自动格式化代码。

gofmt 是 Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格，常见 IDE 都支持方便的配置。此外 goimports 也是 Go 语言官方提供的工具，可以实现自动增删依赖的包引用、将依赖包按字母序排序并分类。

命名规范

变量：简洁胜于冗长。缩略词全大写（比如 ServeHTTP），但当其位于变量开头且不需要导出时，使用全小写（比如 xmlHTTPRequest）。变量距离其被使用的地方越远，则需要携带越多的上下文信息。

函数：函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的。函数名尽量简短。当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义。当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息。

package：只由小写字母组成，不包含大写字母和下划线等字符。简短并包含一定的上下文信息，例如 schema、task 等。不要与标准库同名。

以上建议均引用自网络，遵循编码规范，平时也要多加练习。