高质量编程简介及编码规范|青训营笔记

37 阅读2分钟

这是我参与「第五届青训营 」笔记创作活动的第3天

重要内容

  • 高质量编程
  • 性能优化

详细内容

高质量编程

简介

简单性

消除冗余复杂性

可读性

代码是写给人看的。首先自己读之前的代码自己要能看懂,等到团队协作的时候,别人最好也能看懂。要求逻辑清晰。实际场景中,就是项目会不断迭代,要求理解代码逻辑。

生产力

团队协作,要求新手也能快速上手

编码规范

  • 格式

使用了gofmt自动格式化

  • 注释

比如说一个函数你要注释它的作用,如何做的(参数啊,return啊),实现的原因,什么情况下会出错。

  • 命名规范

命名规范就是要英语要学好啊,使用下划线,感觉也考虑到代码的简洁性。 变量考虑{},在不影响对代码的理解的情况下,尽量使用缩写。 函数不包含所在包名的信息 包名只是用小写字母,尽量简短,使用单数

  • 控制流程

尽量保证正常代码路径为最小缩进,处理逻辑尽量走直线,注意控制流程里面的复杂嵌套,很容易出现错误。

image.png

image.png

  • 错误

在实际场景中,错误也是很重要的!!!但是在学校中,错误不怎么使用,因为代码都是老师反复实验过的。但是这时候需要自己去考虑会出现什么错误,出现错误怎么表示,怎么解决。在之前的代码实战中,也意识到了简单的小程序,代码也会排除错误。

优先使用error.New()创建匿名变量来直接表示简单错误。return error.New("")

还有错误链

recover,在当前goroutine的被defer函数中生效,defer是后进先出,在函数返回前被调用。

性能优化建议

先实现了基础功能后,再考虑优化。

个人总结

好难,但你是要学啊QAQ