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

前言

本文章记录了高质量编程与性能调优Go语言部分内容，记录了今天所学的部分知识

1.高质量编程

1.1简介

什么是高质量?

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

• 各种边界条件是否考虑完备
• 异常处理情况，稳定性保证
• 易读易维护

1.1.1编程原则

实际应用场景千变万化，各种语言的特性和语法各不相同但是高质量编程遵循的原则是相通的。

1. 简单性

• 消除“多余的复杂性”，以简单清晰的逻辑编写代码
• 不理解的代码无法修复改进

2. 可读性

• 代码是给人看的，不是给机器看的
• 编写可维护代码的第一部是确保代码可读

3. 生产力

• 团队整体工作效率非常重要

1.2编码规范

1.2.1注释

公共符号始终要有注释

• 包中声明的每个公告符号：变量、常量、函数以及结构都需要添加注释
• 任何既不明显也不间断的公共功能必须予以注释
• 无论长度或复杂度如何，对库中的任何函数都必须进行注释
• 不要简洁的注释实现接口的方法

1.2.1代码格式

推荐使用gofmt自动格式化代码 gofmt Go语言官方提供的工具，能自动格式化Go语言代码为官方统一的风格，常见的IDE都支持方便的配置

goimports

Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母排序并分类

1.2.2注释

• 注释应该做的
  • 注释应该解释代码作用
  • 注释应该解释代码如何做的
  • 注释应该解释代码实现的原因
  • 注释应该解释代码什么情况会出错

引用参考

参考的部分内容来源于以下课程或网页：

• 字节内部课：Go 高质量编程与性能调优