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

高质量编程

什么是高质量编程

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

• 各种边界条件是否考虑完备
• 异常情况处理，稳定性保证
• 易读易维护

编程原则

实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的

1、简单性

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

2、可读性

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

3、生产力

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

如何编写高质量的Go代码

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

注释

1、公共符号始终要注释

• 包中声明的每个公共的符号（包括变量、常量函数以及结构）都需要添加注释
• 任何既不明显也不简短的公共功能必须予以注释
• 无论长度或复杂程度如何，对库中任何函数都必须进行注释
• 不需要注释实现接口的方法

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

• gofmt：Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见IDE都支持方便的配置
• goimports：也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类

命名规范

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息
• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
• 函数名尽量简短
• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时（T不是Foo），可以在函数名中加入类型信息