这是我参与「第五届青训营」笔记创作活动的第6天,今天我将总结一下Go语言中编码规范的相关内容与概念,主要从命名规则几方面来进行总结。
命名规则
此处并不全是笔记,也有自己的理解添加的内容,驼峰命名在课堂上没有进行说明,但个人觉得应当更加规范化的命名,通过参考demo与其他代码进行进一步总结。大佬轻喷,欢迎指出问题与进行交流。
变量
三个基本要求:
- 简洁明了,一般使用小驼峰命名,如:theElement
- 缩略词全大写,当位于变量开头且不需导出时,使用全小写 例如使用ServeHTTP而不是ServeHttp,使用XMLHTTPRequest或者xmlHTTPRequest
- 变量距离使用地方越远,需携带越多上下文信息 全局变量在其名字中需要更多的上下文信息,使得在不同地方可以轻易辨认出其含义
函数
两个基本要求:
- 函数名尽量简短,使用大驼峰命名,如:FindElement
- 函数名不携带包名的上下文信息,因为包名和函数名总是成对出现的
其他要求:
- 当名为foo的包某个函数返回类型Foo时,可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时(T并不是Foo),可以在函数名中加入类型信息
软件包
基本要求:
- 只由小写字母组成,不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task 等。
- 不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足,以标准库包名为例:
- 不使用常用变量名作为包名。例如使用bufio 而不是 buf·
- 使用单数而不是复数。例如使用encoding而不是encoditings
- 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短
错误
简单错误:
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化需求的简单错误:使用fmt.Errorf进行格式化错误
错误链: 在fmt.Errorf中使用%w关键字关联到错误链中:
if err!=nil{
return fmt.Errorf(“error:%w”, err) //err为关联的错误
}
错误的判定:
errors.Is(err, fs.ErrXxx) //判定错误链上的所有错误是否含特定错误
其实对于错误链我个人并不是很了解,后续还需要在实践中进一步深入了解,在这里就先进行记录吧。