这是我参与「第五届青训营 」伴学笔记创作活动的第 7 天
常见编码规范
代码格式
- 使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
总结
-
提升可读性，风格一致的代码更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本
-
注释应该解释代码作用
- 适合注释公共符号，github.com/golang/go/b…
-
注释应该解释代码如何做的
- 适合注释方法，github.com/golang/go/b…
-
注释应该解释代码实现的原因
- 解释代码的外部因素，github.com/golang/go/b…
- 注释应该解释代码什么情况会出错
-
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- github.com/golang/go/b…
- github.com/golang/go/b…
命名规范
-
variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
-
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
-
package
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
总结
- 关于命名的大多数规范核心在于考虑上下文
- 人们在阅读理解代码的时候也可以看成是计算机运行程序，好的命名能让人把关注点留在主流程上，清晰地理解程序的功能，避免频繁切换到分支细节，增加理解成本
控制流程
- 避免嵌套，保持正常流程清晰
- 如果两个分支中都包含 return 语句，则可以去除冗余的 else
-
尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性
- Go 公共库的代码
- github.com/golang/go/b…
总结
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 提高代码的可读性
