程序员-不要做敲代码的机器

    第一次机房收费系统顺利做完了，没有严格的验收就草草的了尾了，文档马马虎虎照着模板改了改，UML在写代码过程中也被丢的九霄云外了。 最终的结果就是：系统做完了，功能实现了，文档，图都扔一边了，导致第二次验收不合格，开始补文档，补注释，改图。

    通过这次补文档的收获拿出来跟大家分享一下：

 

  1. 没有文档，就等同于敲代码的机器，想到哪敲到哪，错了重头再来。

    在说文档之前先看一下百科的解释：软件开发文档是软件开发使用和维护中的必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。

    文档在初学者看来（自己）有时候把它当做浪费时间的事情，个人开发可能体现不出来。一个Team开发至今看来我们还可以完成，是因为我们把本该存在的文档化作了语言交流， 想想我们的合作开发是这样吗？就像软件的接口不统一，再强大的功能也不能组装到一起。

  2. 文档是代码的灵魂，让代码活起来

    做每件事情都跟写文档一样，做好提前的规划，就像我们的谷歌日历一样，我们只需要去做就可以了。如果程序员是敲代码的机器，那文档就是他们的灵魂。敲代码只是把我们的想法落实到文字，把我们的思想用代码体现出来。

  3. UML图--可以改，但不能扔。

    ＵＭＬ图是前期设计的模型，包图提现了系统的整体架构，用例图体现出系统的功能模块，时序图把每个功能细化。ＵＭＬ图可以说是代码的前期映射，当往往敲代码过程中会发现ＵＭＬ图中的不足和缺陷，自己所犯的错误就是发现错误没有改ＵＭＬ图而是直接扔到了，按照自己的意愿来。如果是合作开发的话，图没有更新，最终导致代码整合不到一起。

　４. 代码注释

     没有不需要修改的代码，二次修改，多次修改，不同人修改。光秃秃的代码在不熟悉业务的的情况下就是一堆乱码。代码维护可以说是天方夜谭。就连自己再补注释的时候，看着自己写的代码都要思考半天。看代码先看注释，没有注释，无形中会增加工作量！

  5. 命名规范

    做软件不是只是为了开发软件，更重要的是维护软件，直观明了的命名规范使得代码更有生命力，提高可理解性。

  总结：栽了个跟头，疼但有收获。回去看看又是另外一番收获。学习就是这样。代码是有生命的，文档，注释，命名是我们程序员的三大法宝。与其说程序员是敲代码的机器，不如说程序员是代码的操控人。