这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
本文代码均出自第五届青训营

高质量编程

简介

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

编程原则

简单性

• 消除“多余的复杂性”，以简单清晰的逻辑写代码
• 不理解的代码无法修复改进

可读性

• 代码是写给人看的，而不是机器
• 编写可维护代码的第一步是确保代码可读

生产力

• 团队整体工作效率非常重要

编码规范

代码格式

gofmt

Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见的IDE都支持(可能自带)
推荐使用gofmt自动格式化代码

goimports

也是GO语言官方提供的工具，实际等于gofmt加上依赖包管理
自动增删依赖包的应用，将依赖包按字母分类排序

注释

好的代码有很多注释，坏代码需要很多注释

注释的作用

• 解释代码作用：注释公共符号(常量、变量、函数)
• 解释代码是如何做的
• 解释代码实现的原因
• 解释代码什么情况会出错

命名规范

好的命名就像一个好笑话。如果你必须去解释它，那就不好笑了。

变量命名

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要给外部使用时，使用全小写
  • 例如使用ServeHTTP而不是Servehttp
  • 使用XMLHTTPRequest或者xmlHTTPRequest
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

函数命名

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

包命名

• 只有小写字母组成，不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息
• 不要与标准库同名
• 尽量做到：
  • 不使用常用变量名作为包名
  • 使用单数而不是复数
  • 谨慎地使用缩写

控制流程

• 避免嵌套，保持正常流程清晰
• 尽量保持正常代码路径为最小缩进，处理逻辑尽量走直线
• 提升代码的可维护性和可读性

错误和异常处理

简单错误

• 简单错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
• 优先使用errors.New来创建匿名变量来表示简单错误
• 如果有格式化的需求，使用fmt.Errorf