读书笔记 | 敏捷编码&敏捷调试

　　这周的个人项目让我感受到自己在编程方面的不足和缺陷，所以选择了《高效程序员的45个习惯》中的敏捷开发和敏捷调试两个章节进行阅读。

　　以下将对敏捷开发和敏捷调试展开详述。

　　

　　【敏捷开发】

• 注释 | 以前写代码有时会为了写注释而写注释，既费时费力又显得多余而无效果，其实，在代码可以传递意图的地方不要使用注释，例如：bool isStartofWord 就无需添加注释说明变量名含义，又如 int getLinesofFile(string filename) 也无需添加注释说明函数用处。换言之，解释代码做了什么的注释用处不那么大。相反，注释要说明为什么会这样写代码。比如，对于上述的函数可以添加如下注释：//count lines by calculate the number of '\n', and the number of lines equals the number of  '\n' plus one if the file isn't empty.
• 增量式编程 | 不要等待着程序全部写完后在一口气调试，而应该采用增量式编程。每写完一个函数就应当设计一个测试单元去测试，而且为了保证函数的鲁棒性，测试单元应当进行至少一次的重构，以保证测试的有效性。类似的，每写完一个模块也应该进行关于该模块的综合测试。即采用小步伐的代码构思，实现，测试与调整来实现代码的推进。
• 保持简单优雅 | 繁琐的代码自己查错和修改都很痛苦，因此保持代码的简单优雅非常重要。优雅的代码第一眼看上去，就知道它的用处，而且很简洁。但是这样的解决方案不是那么容易想出来的。这就是说，优雅是易于理解和辨识的，但是要想创建出来就困难得多了。所以当我们觉得自己的代码过于繁杂时，可以考虑自己的编程思路是否可以进行优化。
• 注意内聚 | 设计类的时候要注意控制类的规模，不要无所不含，也不要过于分散。一个类实现某一特定的功能。

 

　　【敏捷调试】

• 解决方案日志 | 我们经常碰到这样的情况，这种错误以前遇到过也解决过，但是就是不记得解决的措施了。一种良好的解决方法是维护一个解决方案日志（日期，问题简述，解决方案详述，链接或者代码片段等补充信息）。日后方便通过关键词检索快速定位解决方案。另一方面，解决方案日志要保持轻量级和简单，不要在记录问题上花费比解决问题更多的时间。可以考虑Wiki等多人协作平台进行共同维护。
• 不要忽视警告 | 不要因为是警告就放任不管！
• 单元测试 | 掌握常用的单元测试方法。