这是我参与「第五届青训营 」伴学笔记创作活动的第 4 天
在编写代码的时候，我们需要时刻注意自己的代码质量，否则会造成代码的可读性、效率、可维护性等降低。
什么是高质量编程
- 编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
- 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
- 高质量的编程需要注意以下原则：简单性、可读性、生产力
代码格式
在进行开发时，注意使用gofmt来自动格式化代码，让代码的格式和官方推荐的格式保持一致。
这样会提升代码的可读性，让所有代码风格统一。并且这样会降低很多学习成本、团队合作、代码Review成本。
注释
命名
变量
- 尽量简洁
- 缩写词全大写，不需要导出则开头则小驼峰
- 变量带上上下文信息，让人能看出他的含义
函数
- 不携带包名的上下文信息
- 尽量剪短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
包
- 全部小写
- 简短并包含一定的上下文信息
- 不要和标准库同名
错误处理
- 简单错误 优先使用errors.New来创建匿名变量来表示该错误。
- 使用errors.is 来判定错误
- 不要在业务代码中使用panic
- 如果程序启动阶段出错，可以使用panic
