“梳子”的用途很大

来源:互联网 发布:华为云计算工程师 编辑:程序博客网 时间:2024/04/25 22:42

   在学软件工程、UML建模的时候,最容易见到“规范”、“指导开发”等字眼,那个时候我们也是这么一个字一个字的学的。大家都知道软件系统的开发过程是非常严谨的,正由于非正规开发带来太多的弊端,则有人推出了规范建模、文档驱动开发。

     写文档、建模、做设计,这都是我们现在都要经历和要求的。文档的重要性,往往都是在发挥着一个Report、一个指南的作用。也许那些一边喝着咖啡、一边通宵纠结于如何更好的读懂别人代码的同学们更了解文档的重要性。

    当面对一大屏幕少量注释的代码的时候,心里最想的便是哪位好心人能拿出一份规范文档给我瞅瞅呢。当要了解一个功能实现流程的时候,也只能一下一下F11地走下去,最迫切的不是去睡觉,而是想要一份详细规范的时序图。

     维护一个系统,比作梳理满头长发。只要有梳子,不管是谁都能把头发理顺清楚,有了梳子,更是能把小小的“虱子”(bug)一只一只揪出来。这也是详细规范的开发文档的重要作用。这样的好处,最大体现为即便核心开发人员离位了,其他人接替过来,工作不至于搁浅。

     道理大家都清楚,但是做起来却成了你是你我是我,仿若旁人一般。

     规范开发,为了你我他,建议大家从每一个subfunction开始,写明白块注释,标清楚关键量。

     细节决定成败,这句话不假。