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

高质量编程

如何写出更简洁清晰的代码，在工作中，编程式团队合作的工程，好的代码让其他人更容易在你的基础上开发，同时出问题的概率更低，大家更乐于与你工作，也让团队更高效，另外在面试的时候，也有编码环节，能不能用代码清晰的表达出你的思路，让面试官额外加分。

命名规范

变量

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

函数

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
• 函数名尽量简短
• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时（T并不是Foo），可以在函数名加入类型信息

包

• 只由小写字母组成，不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息
• 不要与标准库同名

以下规则尽量满足，以标准库包名为例

• 不使用常用变量名作为包名
• 使用单数而不是复数
• 谨慎使用缩写

小结

• 核心目标是降低阅读理解代码的成本
• 重点考虑上下文信息，设计简洁清晰的名称

控制流程

避免嵌套，保持正常流程清晰

如果两个分支中都包含return语句，则可以去除冗余的else

尽量保持正常代码路径为最小缩进

• 优先处理错误情况，特殊情况。尽早返回或继续循环来减少嵌套
• 最常见的正常流程的路径被嵌套在两个if条件内
• 成功的退出条件是return nil，必须仔细匹配大括号来发现
• 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
• 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

小结

• 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
• 正常流程代码沿着屏幕向下移动
• 提升代码可维护性和可读性
• 故障问题大多出现在复杂的条件语句和循环语句中

、