这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
原则
-
简单性
- 消除多余的复杂性，几简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
-
可读性
- 代码是给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
-
生产力
- 团队整体工作效率非常重要
代码格式
go工具gofmt
可以在push时对整个项目进行gofmt，将代码统一为官方统一风格
goimports
实际等于gofmt加上依赖包管理
自动增删依赖的包应用、将依赖包按字母序排序并分类
注释
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
命名规范
变量命名
-
简洁胜于冗长
-
缩路词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 Servelttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
-
变量距离其被使用的地方越远，则需要携带越多的上下文信息
-
全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
函数命名
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo的包某个函数返回类型T时(T 并不是Foo），可以在函数名中加入类型信息
包命名
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用encoding而不是encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
错误和异常
- 错误的 Wrap 实际上是提供了一个 error 嵌套另一个error 的能力，从而生成一个 error 的跟踪链
- 在fmt.Errorf 中使用：%w 关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特殊错误，使用errors.Is
- 不同于使用==，使用该方法可以判定错误脸上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As# 高性能编程与性能调优实战
