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

高质量编程

什么是高质量：

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

编程原则：

• 简单性

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

• 可读性

  • 代码是写给人看的
  • 编写可维护代码的第一步是确保代码可读

• 生产力

  • 团队整体工作效率

编码规范

• 代码格式

  • 使用gofmt自动格式化代码，使用goimports（增加了依赖包格式化功能）

• 注释（快让我吐槽一下go的注释又臭又长）

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

• 命名规范

• 控制流程

• 异常处理

引用

1. 稀土掘金内部课 后端入门 - Go 语言原理与实践