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

前言

本文写作目的是为了在学习的过程中对学习的心得进行记录以及对学习内容进行总结，方便后续回看，若文中有错误，望大家不吝赐教

高质量编程

• 怎样的代码能够称为一份高质量代码？

一句话总结就是“正确可靠，简洁清晰”

具体标准如下：

1. 边界情况考虑完备
2. 异常处理完善
3. 易读易维护

• 编码规范

好的编码规范可以帮助我们提高开发效率，而在项目合作的过程中，我们的代码需要注意以下几个方面：

1. 代码格式

   工具：gofmt

2. 注释

   注释应该做的

   • 解释代码作用
   • 解释代码怎么做
   • 解释代码实现原因
   • 解释代码什么时候会出错，出错的结果

3. 命名规范

   核心是为了降低阅读代码成本，所以在命名上纠结的时候，去思考怎样更简洁就好了，比如说在http包里面方法名命名为serve更合适，调用时直接用http.serve()即可，因此命名时需考虑实际需求

4. 控制流程

   尽量实现控制流程的直线执行，避免复杂分支嵌套等可以提升代码的可维护性和可读性

5. 错误和异常处理

   这一块还不太会，让我再研究研究

• 写代码过程中的性能优化建议

1. 可以用Benchmark工具对代码进行性能基准测试
2. Slice和map预分配内存会大大提高运行效率
3. 用copy代替re-slice会节省内存空间消耗
4. 多个字符串拼接的时候，用strings.Builder会比直接用 + 或者bytes.Buffer更快

总结

经过这一节课的学习，让我认识到在项目开发的过程中，代码的质量对开发效率的影响，以及对后期维护成本的影响，好的规范的代码可以帮助我们进行团队合作与沟通，而在编写代码的过程中，经过经验的积累，就避免掉一些需要到后期进行大范围排查的错误，对整个项目开发而言，是十分有益的。