控制你的代码整洁有效—业务管理系统开发组第一期分享

为何要控制你的代码

是的,我们就是一群代码猴子,上蹿下跳,自以为领略了编程的真谛。可惜,当我们抓着几个酸桃子,得意洋洋坐在树枝上,却对自己造成的混乱熟视无睹。那堆“可以运行”的乱麻程序,就在我们的眼皮底下慢慢的腐化。摘自《代码整洁之道》

统一的编码规约

遵守并使用统一的编码规约(业务管理系统开发组代码规约)
代码规约主要在如下几个方面对大家的编码进行规范:

  • 命名
  • 类以及方法的编写
  • 代码注释
  • 代码格式
  • 异常处理
  • 并发处理
    请大家仔细阅读代码规约,并严格遵守。

应用实践

  1. 确保对需求以及编程任务真正的理解。
    情况一:需求会上产品经理和程序员一起讨论需求,无论这个需求是不是你要做的,请必须认真讨论并思考,因为下一次你做的功能很可能就与之相关,系统内的很多功能并非是独立的。
    情况二:很多人接到任务初略的看了需求然后按照自己的思路开始写起了代码,然后写完草草的上了测试,然后测试发现做的东西和需求根本不一样,然后就是反复的工作。这样的情况时常发生在我们的身边,项目因此延期,代码质量也因此下降。所以不要轻易的开始编写代码,在你写代码的时候请确保你已经真正的理解你的需求。并为此做了前期的设计,胸有成竹个人认为很适合开始写代码的当时的心情。
  2. 必要的设计
    需求往往不是那么的简单,涉及到各种情况的处理,必要的设计确保我们编写的代码的质量和品质。常用的草图,流程图,设计文档等都可以让我们的思路变得更加清晰。设计都出来了,编码还会很难么,编码不过是将设计转化成代码罢了。
  3. 编写代码
    按照设计,遵守团队的代码规约,运用严密的逻辑,发挥你的编码才能,代码就这样完成了。
  4. 测试代码
    对自己代码不测试的程序员不是好程序员,自己都没有测试过的代码直接给测试这不是坑测试么。首先代码至少要能正常运行,才可以提交测试,其次对关键业务逻辑一定要有严密的单元测试。这是对自己负责也是对测试负责。
  5. 优化代码
    代码写完了,测试也差不多了,刚好还剩下大半天,是时候优化一下这周写的代码了。
    情况一:检查写的代码是否都符合代码规约。
    情况二:检查代码逻辑是否有漏洞
    情况三:是不是可以更优雅的实现这个功能
  6. 代码互检
    程序员一般来说会有点自恋经过上述几个步骤一般都觉得自己的代码已经完美了。事实上并非如此,因此我们团队组员之间相互检视,相互发现问题,可以让自己变的更加优秀。
  7. 总结收获
    写完代码,必然是有所收获的,无论是编码技能的提升,还是对业务流程的了解,最好都可以记下来,因为只有这样你才能不断的进步。到这来可能有人会说我每天编写的东西都一样,进步太慢了,那你可曾想过,既然你发现你每天做的都一样,是否可以设计一个更好的方法来处理同样的工作呢?
  8. idea中常用优化代码快捷键,以及建议
  • Ctrl+Alt+L 格式化代码
  • Ctrl+Alt+O 优化导入的类和包如:可以去除没有使用到的包
  • Alt+Insert 生成代码如:get,set方法,构造函数
  • Shift+F6 重构-重命名
  • Ctrl+Alt+ left/right 返回至上次浏览的位置
  • 谷歌代码风格其中有idea相关的配置xml,可根据自己的代码规约进行修改相应的参数,然后导入idea中这样格式化代码时就会采用你配置文件进行格式化。
  • 代码模板,可以对一些代码设置相应的代码模板加快代码开发。

下期分享:使用FindBugs-IDEA插件找出代码中的潜在问题

你可能感兴趣的:(控制你的代码整洁有效—业务管理系统开发组第一期分享)