这是我参与「第六届青训营」伴学笔记创作活动的第 3 天，今天学习了高质量编程相关的内容，现在来对我学习的知识进行总结：

本期目录

• 高质量编程
• 学习心得

高质量编程

编码原则

• 简单性：以简单清晰的逻辑编写代码，不理解的代码无法修复改进
• 可读性：确保代码可读
• 生产力：团队整体工作效率非常重要

编码规范

注释

注释应该做的

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

命名规范

variable

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息
• 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

function

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
• 函数名尽量简短
• 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
• 当名为 foo 的包某个函数返回类型 T 时 (T 并不是 Foo)，可以在函数名中加入类型信息

package

• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息。例如 schema、task 等
• 不要与标准库同名。例如不要使用 sync 或者 strings

控制流程

• 避免嵌套，保持正常流程清晰
• 尽量保持正常代码路径为最小缩进

错误和异常处理

简单错误

• 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
• 优先使用 errors.New 来创建匿名变量来直接表示简单错误
• 如果有格式化的需求，使用 fmt.Errorf

错误和异常处理

• 错误的 Wrap 和 Unwrap错误的 Wrap 实际上是提供了一个 error 嵌套另一个error 的能力，从而生成一个 error 的跟踪链
• 在 fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中

错误判定

• 判定一个错误是否为特定错误，使用 errors.ls
• 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

学习心得

本篇文章为知识点笔记，来自课程高质量编程简介及编码规范 - 掘金 (juejin.cn)，通过学习，我了解了如何正确进行命名，了解了命名规范。我认识到，只有规范编程和注释，蔡能提高编程的效率