(WWDC) 良好的开发者习惯

内容概览

• 组织
• 版本控制
• 注释 & 文档
• 测试
• 分析
• 评估
• 解耦
• 依赖管理

---

组织

混乱不堪	井然有序

组织有序的工作空间可以大幅度提升你的工作效率！

Xcode Group 和 Finder Folder 一一对应：

利用 Storyboard 的 Reference 功能，合理划分不同模块的 Storyboard：

更新项目设置为 Xcode 推荐的配置：

使用最新的构建系统：

总结

• 根据功能来进行模块划分
• 使项目的组织结构和文件的组织结构相同
• 拆分庞杂的 storyboard
• 持续更新项目文件
• 抛弃无用的代码片段 (版本控制系统可以很容易找回)
• 解决导致警告的根本问题

---

版本控制

推荐使用 Git 进行版本控制：

你可以很方便地对工作成果进行整合：

总结

• 使用版本控制系统
• 尽可能地使提交内容精简、独立
• 添加有用的提交信息，便于以后查找
• 利用分支进行调试和测试工作

---

注释 & 文档

维护没有文档的代码时，你总是要去熟悉已有代码的实现，然后在脑海中构建起上下文。
如果上下文的跨度比较广时，文档是必不可少的。

使用描述性的名称对变量、方法进行命名，使用注释进行合理的解释：

详尽的文档可以帮助使用者快速地了解代码的用法以及注意事项：

按下快捷键，快速地为代码添加文档注释：

按住 Option 然后点击鼠标左键，即可查看代码的文档：

总结

• 注释对于以后理解代码至关重要
• 好的注释可以提供背景和推理
• 使用描述性的变量、常量名称
• 使用文档

---

测试

测试（常见的是单元测试）可以有效地保证代码的质量。
编写测试代码时，你需要关注测试的覆盖率。

可靠的测试可以保证重构时的自信！你会对这样的测试心存感激！

总结

• 写单元测试
• 每次提交代码前，运行单元测试
• 为持续集成构建基础

---

分析

制造弱网络环境，模拟真实的使用场景：

使用 Address Sanitizer （内存错误问题）, Thread Sanitizer（线程竞态等问题）, Undefined Behavior Sanitizer（0做除数等问题）, Main Thread Checker（非主线程操作UI） 检查运行时可能出现的诸多问题：

Debug 导航器页面可以查看 CPU， 内存， 磁盘， 网络相关的信息：

使用 Instruments 进行问题剖析，比如使用 Time Profiler 检查耗时操作：

总结

• 使用 Network Link Conditioner 模拟弱网络环境
• 使用 Sanitizers 和 Checkers 监测运行时故障
• 使用 Debug 导航器页面的工具测量性能和能耗
• 使用 Instruments 探查问题成因

---

评估

Code Review 可以帮助你改善代码质量。

在进行 Code Review 时，你需要理解每一处改动，然后构建代码并验证测试能否成功通过。
还需要对代码进行校对，比如：命名规范等。

不同的团队有不同的代码风格和规范，比如：color 和 colour 的小小差别，就会使搜索结果相差甚远。

如果你是独立开发者，建议你参与社区协作开发(开源库)或者寻找你的伙伴！

总结

• 在你的开发实践中加入 Code Review
• 理解每一行代码
• 构建并运行代码
• 为代码运行测试
• 校对代码风格、拼写以及语法

---

解耦

使用 Swift Package Manager 进行代码库管理。

你可以在常见的代码仓库平台找到开源库，也可以在这些地方发布你自己的代码库：

代码库需要提供必要的文档：

总结

• 判定功能分割部分，然后拆分
• 跨多个应用程序扩展你的劳动成果
• 通过 extension 提升效率
• 和广阔的社区共享你的劳动成果
• 文档是必不可少的

---

依赖管理

• 合理地使用社区和开源项目
• 彻底地理解依赖
• 确保尊重隐私权
• 做好计划，以防代码库消失或者不再维护

---

参考内容：
Great Developer Habits

转载请注明出处，谢谢~