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

63 阅读2分钟

高质量编程与性能调优实战学习笔记

什么是高质量代码

高质量代码:编写的代码达到正确可靠、简洁清晰的目标,可称为高质量代码。

编程原则

  • 简单性:以简单清晰的逻辑编写代码,难以理解的代码无法进行修复改进。
  • 可读性:编写可维护的代码的第一步是保证可读性,代码是写给人看的而不是写给机器看的。
  • 生产力:代码要为团队的整体效率服务。

Go语言编程规范

代码格式

使用gofmt自动格式化代码。
gofmt:Go语言官方提供的自动格式化Go语言代码的工具,常见的IDE都支持方便的配置。
goimports:Go语言官方提供的工具,实际等于gofmt加上依赖包管理,自动实现增删依赖包的引用、将依赖包按照字母顺序排序分类。

注释

注释的作用包含:

  • 解释代码作用 -> 注释公共符号
  • 解释代码如何实现功能 -> 注释实现过程
  • 解释代码实现的原因 -> 解释代码的外部因素,提供额外的上下文
  • 解释代码在什么情况下会出错 -> 解释代码的限制条件

命名规范

  • 命名时简洁胜于冗长。
  • 缩略词全大写,但是当缩略词位于变量开头且不需要导出时使用全小写。
  • 变量距离其被使用的地方越远,则需要携带越多的上下文信息。

个人思考与总结

Q:为什么编写代码时需要遵守编程规范
A:遵循统一的编程规范,使得代码整洁统一,容易被读懂,更利于后续的修改和维护