什么是高质量
编写的代码能够达到正确可靠、 简洁清晰的目标可称之为高质量代码 各种边界条件是否考虑完备 异常情况处理,稳定性保证 易读易维护
1.1 简介
编程原则 实际应用场景干变万化,各种语言的特性和语法各不相同 但是高质量编程遵循的原则是相通的 简单性 消除”多余的复杂性”,以简单清晰的逻辑编写代码 不理解的代码无法修复改进 可读性 · 代码是写给人看的,而不是机器 编写可维护代码的第一步是确保代码可读 生产力 团队整体工作效率非常重要 Go语言开发者 Dave Cheney
1.2.1 编码规范-代码格式
推荐使用 gofmt 自动格式化代码 gofmt Go 语言官方提供的工具,能自动格式化 Go 语言代码为官方统一风格 常见IDE都支持方便的配置
1.2.2 编码规范-注释
- 注释应该做的
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
好的代码有很多注释,坏代码需要很多注释
1.2.3 编码规范-命名规范
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
- 以下规则尽量满足,以标准库包名为例
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用 encoding 而不是 encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
1.3性能优化建议-slice
- 另一个陷阱: 大内存未释放
- 在已有切片基础上创建切片,不会创建新的底层数组
- 场景
- 原切片较大,代码在原切片基础上新建小切片
- 原底层数组在内存中有引用,得不到释放
- 可使用 copy 替代 re-slice