高质量编程与性能调优实战| 青训营笔记

136 阅读2分钟

准备 尝试使用 test 命令,编写并运行简单测试 尝试使用 -bench参数,对函数进行性能测试 推荐阅读Go代码Review建议、Uber的Go编码规范 高质量编程 简介 高质量编程简言之就是代码达到正确、可靠、简洁清晰的目标:

正确性:考虑各种边界条件,错误的调用正确处理

可靠性:异常或错误处理策略保障依赖的服务出现异常能够处理

简洁:逻辑简单,后续调整或新增功能能快速支持

清晰:代码易于阅读理解,重构或修改功能不易出问题

编程原则 实际应用场景千变万化,各语法特性和语法各不相同,但原则相通

简单性:逻辑清晰简单,无多余复杂性,易于理解改进 可读性:代码给人看而非机器,可维护性前提是可读性 生产力:团队整体效率非常重要 编码规范 代码格式 用 gofmt和goimports格式化代码和包,保证代码与官方推荐格式一致

Good code has lots of comments,bad code requires lots of comments.

  • 注释应该解释代码作用,适合注释公共符合,参考官方代码
  • 注释应该解释代码如何做的,适合注释方法,参考官方代码
  • 注释应该解释代码实现的原因,解释代码外部因素,参考官方代码
  • 注释应该解释代码什么情况会出错
  • 包中每个公共符合:变量、常量、函数及结构体都要注释,参考官方代码

image.png

image.png

image.png

image.png

小结

  • 代码是最好的注释
  • 注释应提供代码未表达出的上下文信息,包括作用、实现、原因、出错情况等