这是我参与「第五届青训营 」伴学笔记创作活动的第 5 天。
高质量编程
1、什么是高质量编程
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。高品质编程,不但结果是高品质的,而且开发过程效率高、程序运行稳定、性能高,代码简洁美观、易于维护。
高质量代码具有的特点:
1、可读性高;
2、结构清晰;
3、可扩展;
4、代码风格统一;
5、低复杂性;
6、简练;
总的来说就是代码做到了正确性、可靠性、简洁、清晰;
2、GO语言中编码规范
1、 使用gofmt自动格式化代码;
2、 注释做到解释代码作用、解释代码如何做、解释代码实现的原因、解释代码什么时候会出错、注释应提供代码未表达出的上下文信息;
3、 公共符号要进行注释、函数进行注释,但不需要注释实现接口的方法;
4、 注意命名规范,使用统一的命名规范,简洁的命名比冗长的命名要好;
5、 进行命名的核心目标是降低阅读代码的成本,考虑上下文信息;
6、 控制流程避免嵌套,保持正常流程清晰;
7、 注意代码的缩进大小,保持代码逻辑清晰;
8、 简单错误可以使用errors.New()来表示,可以使用fmt.Errorf()进行格式;
9、 在fmt.Errorf()中使用%w关键字将一个错误关联至错误链中;
10、判断一个错误是否为特定错误,使用errors.is()函数,该函数可以判定错误链上所有错误是否含有特定的错误;
11、在错误链上获取特定种类的错误使用errors.As()函数;
12、若问题可以被屏蔽或者解决使用error代替panic,当程序启动阶段发生不可逆转的错误时,在init或者main函数中使用panic;
13、recover只能在被defer的函数中使用;
14、如果需要更多的上下文信息,可以在recover后在log中记录当前的调用栈。
引用参考:
高品质编程 - 知乎 (zhihu.com)
如何编写高质量代码 - 知乎 (zhihu.com)
总结
本文是青训营学习中关于Go语言中代码规范的笔记,同时认识到代码规范的重要性。