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

一、本堂课重点内容

• 高质量编程
• 性能调优实战

二、详细知识点介绍

高质量编程

1.高质量编程简介

编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

2.编码规范

编程原则: 简单性、可读性、生产力

代码格式

• 推荐使用gofmt自动格式化代码：gofmt/goimports

注释

• 注释应该做的：

1）注释应该解释代码的作用，适合注释公共符号

2）注释应该解释代码如何做的，适合注释实现过程

3）注释应该解释代码实现的原因，适合解释代码的外部因素

4）注释应该解释代码什么情况下会出错，适合解释代码的限制条件

• 公共符号始终要注释：

1）包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释

2）任何既不明显也不简短的公共功能必须予以注释

3）无论长度或复杂程度如何，对库中的任何函数都必须进行注释

命名规范

• 变量：

• 函数：

• 包：

• 控制流程：

1）避免嵌套，保持正常流程清晰

2）尽量保证正常代码路径为最小缩进

• 错误和异常处理：

1）简单错误

2）错误的Wrap和Unwrap

3.性能优化建议

• Bwnchmark
• slice预分配内存
• map预分配内存
• 使用string.Builder
• 使用空结构体
• atomic包

三、个人总结

高质量编程有时并非是必要的，但在我们学习工作中一定是十分有用的。规范清晰的代码有利于我们更快地理解，通过改变部分代码顺序、预分配内存等方式提高运行效率，这些使我们的代码乃至工作更加高效高质量。