这是我参与「第五届青训营」伴学笔记创作活动的的第4天
go语言高质量编程
1.高质量编程
高质量代码:编写的代码能够达到正确可靠、简洁清晰。
判断方法:1.各种边界条件是否考虑完备。
2.异常情况处理,保证稳定性。
3.团队合作的时候需要易读易维护。
1.简介
编程原则:实际应用场景千变万化,各种语言的特性和语法各不相同,但是高质量编程遵循的原则是相通的
1.简单性
消除“多余的复杂性”,以简单清晰的逻辑编写代码,不理解的代码无法修复改进。
2.可读性
代码是写给人看的,而不是机器,编写可维护代码的第一步是确保代码可读。
3.生产力
团队整体工作效率非常重要
2.编码规范
1.注释:公共符号始终要注释。
包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释。
任何既不明显也不简短的公共功能必须予以注释。
无论长度或复杂程度如何,对库中的任何函数都必须进行注释。
不需要注释实现接口的方法。
2.代码格式
gofmt:能自动格式化Go语言代码为官方统一风格。
goimports:实际等于gofmt 加上依赖包管理。自动增删依赖的包引用、将依赖包按字母序排序并分类。
3.命名规范
变量:简洁胜于冗长,距离其被使用的地方越远,则需要携带越多的上下文信息。全局变量在其名字中需 要更多的上下文信息,使得在不同地方可以轻易辨认出其含义。
函数:函数名不携带包名的上下文信息,尽量简短。
包:只由小写字母组成,不包含大写字母和下划线等字符。简短并包含一定的上下文信息。