这是我参与「第五届青训营」伴学笔记创作活动的的第3天
本节课内容如下
目录
高质量编程
- 高质量编程简介
- 编码规范
- 性能优化建议
1 高质量编程
1-1 什么是高质量
高质量：编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则——go语言开发者Dave Cheney
实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的：
简单性
- 消除”多余的复杂性“，以简单清晰的逻辑编写代码
- 如果产生不理解的代码别人无法修复改进
可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
生产力
- 团队整体工作效率非常重要
1-2 编码规范
- 注释
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 有一个例外：不需要注释实现接口的方法。
- 代码格式
推荐使用gofmt自动格式化代码
gofmt：go语言官方提供的工具，能自动格式化go语言代码为官方统一风格，常见IDE都支持方便的配置。
- 注释内容
注释应该做的：
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外上下文
- 注释应该解释代码什么情况会出错
- 适合解释代码的限制条件
- 小结
- 代码是最好的注释
- 注释应该提供代码未表达出的上下文信息
1-3 命名规范
- 简洁胜于冗长
- 缩略词全大写，但当其位与变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
