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

本篇笔记主要记录一下编程规范的学习知识

1. 注释

• 公共符号都需要注释，可以方便代码的阅读，知道这个公共变量等代码块的作用是什么
• 公共复用代码块也需要注释，表明该代码块的作用是什么
• 任何函数都需要注释，说明函数的作用，传参和返回值是什么
• 任何报错返回需要注释，表明报错的内容和为何会出现错误

2.代码格式

如果对自己的代码格式不是很放心的话，可以使用gofmt自动化格式代码。

当然平时也是需要养好自己的代码格式习惯，如果能养好习惯的话，也不需要去使用这些格式化工具。

3.命名规范

平时也需要注意使用合适的命名规范，比如驼峰命名法。也是个人最经常使用的命名方法，对变量的命名一定要有意义，尽量少用temp这种没有具体含义的变量名。

4.控制流程

对控制流程一定要尽量的简短，比如对一些情况可能err不为nil之后就需要结束当前函数，这时候我们会使用：

if err != nil {
    panic(err)
}

而并不是

if err == nil {
    ...
}else{
    panic(err)
}

从而缩短控制流程的行数。

5.错误处理

在具体的项目中，对每次的错误都需要进行处理，如果可以的话需要进行日志的管理，而在具体项目开发当中，我们使用panic会比较少，因为它会直接终止项目代码的运行，而如果需要恢复需要进行recover的判断处理，而且只能在defer代码块中运行，比较不方便。

人生苦短，不如go浪一下。