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

编码规范

编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。

可以从各种边界条件是否考虑完备、异常情况处理和稳定性保证、易读易维护等角度衡量代码的质量。

可以使用gofmt自动格式化代码，gofmt是Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格。

注释应该解释代码作用、代码如何做的、代码实现的原因、代码什么情况会出错。

variable：

简洁胜于冗长
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
变量距离其被使用的地方越远，则需要携带更多的上下文信息
function
函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
函数名尽量简短
当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
当名为foo的包某个函数返回类型T时（T不是Foo），可以在函数名中加入类型信息
package
只由小写字母组成。不包含大写字母和下划线等字符
简短并包含一定的上下文信息。例如 schema、task等
不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用 encoding 而不是 encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短