这是我在第六届字节跳动青训营后端进阶班的第七篇笔记，主要梳理Go语言高质量编程部分课程内容。

简介

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

高质量编程除了要编写出高质量代码以外，还需要考虑各种边界条件、处理各种异常情况，保证系统的稳定性，同时还需要满足代码的易读性、易维护性。

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

• 简单性：以简单清晰的逻辑编写代码；
• 可读性：确保代码可读才能保证代码的可维护性；
• 生产力：团队的工作效率非常重要。

编码规范

以编写高质量Go代码的代码规范为例：

代码格式

可以使用一些工具来自动格式化代码：

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

注释

注释应该解释代码的作用、如何做的、实现的原因以及什么情况会出错，所以在编码过程中，我们要注释代码的公共符号、实现过程，还要解释代码的外部因素、提供额外的上下文，还有解释代码的限制条件。

通常需要满足：

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

命名规范

对于变量：

• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写；
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息：全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义。

对于函数：

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

对于包:

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

控制流程

• 避免嵌套，保持正常流程清晰；
• 尽量保持正常代码路径为最小缩进：优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套。