这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
一、高质量编程
1.简介
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则
-
实际应用场景千变万化，各种语言的特性和语法各不相同
-
但是高质量编程遵循的原则是相通的
简单性
-
消除”多余的复杂性”，以简单清晰的逻辑编写代码
-
不理解的代码无法修复改进
可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
生产力
- 团队整体工作效率非常重要
2.编码规范
如何编写高质量的 Go 代码
- 代码格式
推荐使用 gofmt 自动格式化代码，gofmt是Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格，常见IDE都支持方便的配置
goimports也是 Go 语言官方提供的工具，实际等于 gofmt 加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类
- 注释
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
注：公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构，都需要添加注释
- 任何既不明品也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 命名规范
variable
- 简洁胜于冗长
- 缩路词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 ServeHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辦认出其含义
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo 的包某个西数返回类型 Foo 时，可以省略类型信息而不导致歧义
当名为 foo 的包某个函数返回类型丁时(T 并不是 Foo），可以在西数名中加入类型信息
package
只由小写字母组成。不包含大写字母和下划线等字符
- 简短井包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用butio而不是but
- 使用单数而不是复数。例如使用encoding 而不是 encodings
- 谨慎地使用缩写。例如使用fmnt 在不破坏上下文的情況下比 format 更加简短
- 控制流程
避免嵌套，保持正常流程清晰
尽量保持正常代码路径为最小缩进
优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
