这是我参与「第五届青训营」伴学笔记创作活动的第 3 天
1.简介
编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
高质量的编程需要注意以下原则：简单性、可读性、生产力
2.代码格式
使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
提升可读性，风格一致的代码更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本
3.命名规范
1.variable
简洁胜于冗长
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
变量距离其被使用的地方越远，则需要携带越多的上下文信息
全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
2.function
函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
函数名尽量简短
当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
3.package
只由小写字母组成。不包含大写字母和下划线等字符
简短并包含一定的上下文信息。例如 schema、task 等
不要与标准库同名。例如不要使用 sync 或者 strings
关于命名的大多数规范核心在于考虑上下文
人们在阅读理解代码的时候也可以看成是计算机运行程序，好的命名能让人把关注点留在主流程上，清晰地理解程序的功能，避免频繁切换到分支细节，增加理解成本
