Go语言高质量编程和代码规范课程总结 | 青训营

154 阅读2分钟

简介

该笔记主要对青训营中提到的部分知识点和要点进行总结,主要包括编码原则,命名规范,注释等。

高质量编程

其实就是代码是否正确可靠和简洁清晰

编码原则

各种语言各不相同,但是编码原则都是差不多的,大概总结为三个点:

1.简单性

在实现代码功能的前提下,代码要尽可能地简单,避免代码出错后找不到问题所在。

2.可读性

在项目开发后期时,往往会对代码进行扩展优化,往往代码要阅读多次,可读性可以减少后续代码阅读时间

3.生产力

整体团队的生产效率,我想这就涉及团队分配工作以及个人代码风格是否良好

注释规范

1.公共符号始终要注释
2.而且注释时要包括你这段代码的作用,代码是如何实现的,实现这段代码的原因,代码在什么情况下会出现错误
3.注释要适当结合上下文的代码

命名规范

作者在以往命名的时候往往喜欢用单个字母或是一些简单的单词来命名,如a,number等,但其实命名时也有原则要遵守,大概可以总结为三个点:
1.命名要尽量地简洁易懂;
2.缩略词要全大写,位于变量开头且不需要导出时才全小写;
3.关于包的命名:要全由小写字母组成,其中不能有大写字母和下划线,而且要简短包含上下文信息,不允许与标准库同名。 而且,命名变量的时候需要更具体更规范,如firstnumber等

控制流程规范

要避免嵌套,如if嵌套; 保持正常代码路径为最小缩进。

小结

课程后面还提到了错误和异常处理规范,其中包括了panic和recover等小块,这里就不一一赘述。 下面主要讲一下我认为的额外应该注意的规范:
1.图片优化:在保证图片清晰度的前提下,尽可能压缩图片大小,采用合适的图片格式,还可以使用懒加载
2.详细的文档配置;
3.制定合理的项目分配工作及项目版本控制:如使用git管理代码,就能保证代码出现各种复杂情况后可以找回。