这是我参与「第五届青训营」伴学笔记创作活动的第 3 天。

1. 写在前面

今天的学习主要是关于高质量编程、编码规范与性能优化。在前两天的课程还在继续消化的情况下，今天课程实操性不是非常多，起到了一个较好的缓冲作用。本篇笔记主要记录关于高质量编程的部分。

2. 编码规范

编码规范主要是从这几个方面去考虑：代码格式、注释、命名规范、控制流程、错误和异常处理。

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

注释应该解释代码作用
- 适合注释公共符号
注释应该解释代码如何做
- 适合注释实现过程
注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外上下文
代码应该解释代码什么情况会出错
- 适合解释代码的限制条件
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中任何函数都必须进行注释

variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
function
- 函数名不懈怠包名的上下文信息，因为包名和函数名总是成对出现
- 函数名应尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时，可以在函数名中加入类型信息
package
- 只有小写字母组成，不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。
- 不要与标准库同名。