这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
一、本堂课重点内容：
本节课主要介绍了：高质量编程与性能调优实战
- 介绍编码规范，帮助大家写出高质量程序
- 介绍 Go 语言的性能优化建议，分析对比不同方式对性能的影响和背后的原理
二、详细知识点介绍：
高质量编程
- 是编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
- 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
- 高质量的编程需要注意以下原则：简单性、可读性、生产力
常见编码规范
代码格式：使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
关于注释
-
注释应该解释代码作用
-
注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
-
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
命名规范
-
variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
-
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
-
package
-
只由小写字母组成。不包含大写字母和下划线等字符
-
简短并包含一定的上下文信息。例如 schema、task 等
-
不要与标准库同名。例如不要使用 sync 或者 strings
-
三、实践练习例子：
- 有什么实践举例帮助理解知识点？
- 通过这个例子，明白了本代码注释的必要性。解释代码的外部因素，github.com/golang/go/b…
四、课后个人总结：
- 今天学习了一些编码规范，深刻理解到其重要性
- 提升可读性，风格一致的代码更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本
- 关于命名的大多数规范核心在于考虑上下文。人们在阅读理解代码的时候也可以看成是计算机运行程序，好的命名能让人把关注点留在主流程上，清晰地理解程序的功能，避免频繁切换到分支细节，增加理解成本
