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

本堂课重点内容

本堂课老师从四个方面进行讲述：

• 高质量编程简介及代码规范 (工作少不了团队协作和优化前人的代码，代码的可读性非常重要)
• 性能优化指南 (根据 Go 语言特性，介绍 Go 相关的性能优化建议，Go 自带了性能评估工具)
• 性能优化分析工具 (主要介绍了性能分析工具pprof，是用于可视化和分析性能、数据的工具)
• 性能调优实战案例 (用 pprof 对项目进行分析之前，首先要能正常打开本地的pprof页面，是否缺少安装相关的组件)

知识点介绍

下面我选择高质量编程这个我比较感兴趣，也是工作中很重要的一个点进行介绍。

高质量编程概念

(什么是高质量编程？)我觉得这是个比较主观的概念，可能不同的人、部门、公司有不同的命名。

如果我自己认为的话，高质量编程就是 代码功能完善 (可以满足基本的业务需求)、可读性强 (部门其他人能够看懂)、命名规范 (符合行业的命名要求，比如《谷歌编码规范》)。

老师给出的定义是编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。 和我的理解基本吻合，但是老师提出了更为细节的点，比如各种边界条件是否考虑完备，异常情况处理，稳定性保护这些都是我之前没有考虑到的。

示例代码

注释应该解释代码作用

// Returns true if the table cannot hold any more entries
fuc IsTableFull() bool

这种注释是没有必要加上的！ 通过名称可以很容易知道作用，加上只会让代码整体冗余，起不到好的效果。另一方面，也说明了代码命名有时候就是注释。

这种注释适合说明公共符号，比如对外提供的函数注释描述它的功能和用途，只有在函数的功能简单而明显时才能省略这些注释。