这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
什么是高质量代码？
编写的代码能够达到正确可靠、简洁清晰的目标称为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
简介
编程原则
实际应用场景千变万化，各种语言的特性和语法各不相同,
但是高质量编程遵循的原则是相通的
- 简单性
消除“多余的复杂性”，以简单清晰的逻辑编写代码
不理解的代码无法修复改进 - 可读性
代码是写给人看的，而不是机器
编写可维护代码的第一步是确保代码可读 - 生产力
团队整体工作效率非常重要
编码规范
代码格式
推荐使用gofmt自动格式化代码
- gofmt
Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格
常见IDE都支持方便的配置 - goimports
也是Go语言官方提供的工具
实际等于gofmt加上依赖包管理
自动增删依赖的包引用、将依赖包按照字母排序并分类
注释
- 公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
注释应该做的
- 注释应该解释代码作用
- 注释应该解释代码如何做到
- 注释应该解释代码实现的原因（适合解释代码的外部因素和额外上下文）
- 注释应该解释代码什么情况下会出错
命名规范
- function(函数名尽量简短 不携带包名的上下文信息，因为他们总是成对出现)
- package（只由小写字母组成，不包含大写字母和下划线等等、字符）
控制流程
- 避免嵌套
- 尽量保持正常路径为最小缩进
- 错误和异常处理
- 简单错误
