18、编程项目经验与图形用户界面设计指南

编程项目经验与图形用户界面设计指南

项目经验总结

当一个项目，至少是特定版本的项目完成后，是时候停下编程和规划的脚步，回顾一下项目，看看哪些地方做对了，哪些地方做错了。以下是一些在编写燃料农场场景项目时总结的经验：
1. 文档字符串编写时机 ：在项目完成之前，不要尝试将参数写入文档字符串。因为重构可能会导致项目项发生变化，比如取消 getter/setter 方法，用属性取而代之。
2. 边编码边写文档摘要 ：在编码时编写基本的文档字符串摘要，这有助于明确函数、方法或类的用途，确保一个函数或方法只做一件事，而不是试图进行多项操作。
3. 每日更新版本号 ：即使不使用持续集成（CI）环境，每天将推送到仓库的最终代码附上版本号也是很有帮助的。不过，随意手动更新版本号虽然在个人项目中可以接受，但不利于识别特定版本中的 bug，也不利于回滚到以前的版本。在团队协作中，代码每晚自动构建并获得内部版本号，手动更新版本号会让程序员稍显滞后。
4. 记录待办事项 ：在代码中随时记录待办事项（TODO），放置位置可由程序员个人决定，除非公司有相关规定。可以将它们放在文件开头、结尾，或者相关代码的位置。
5. 正确看待单元测试失败 ：不要认为单元测试失败是因为代码有问题。在编写程序时发现，大多数测试失败是由于测试接收到了错误的数据，即核心代码是正确的，但测试请求的值有误。
6. 保持单元测试更新 ：如果代码经常重构，保持单元测试的更新会很困难。这时，文档测