这是我参与「第五届青训营 」伴学笔记创作活动的第 7 天
什么是高质量
编写的代码能够达到正确可靠，简洁清晰的目标可称之为高质量编码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则
高质量编程的原则在许多应用场景和语言中是相通的
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
生产力
- 团队整体工作效率非常重要
编程规范
注释
注释应该做的
- 注释应该解释代码作用
- 注释公共符号
- 注释应该解释代码如何做的
- 注释实现过程
- 注释应该解释代码实现的原因
- 解释代码的外部因素
- 提供额外的上下文
- 注释应该解释代码什么情况会出错
- 代码的限制条件
好的代码有很多注释，坏代码需要很多注释
小结
- 代码是最好的注释
- 注释应该提供代码未表达出的上下文信息
命名规范
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 ServeHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辦认出其含义
小结
- 核心目标是降低阅读理解代码的成本
- 重点考虑上下文信息，设计简洁清晰的名称
好的命名就像一个好笑话。如果你必须解释它，那就不好笑了
控制流程
尽量保持正常代码路径为最小缩进
优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
小结
- 线性原理，处理逻程尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
