码迷,mamicode.com
首页 > 其他好文 > 详细

文档设计也需要坚持DRY原则--支付中心应用部署结构图完善

时间:2018-05-31 20:30:00      阅读:181      评论:0      收藏:0      [点我收藏+]

标签:14.   重复   重构   同事   就是   info   需要   play   com   

今天上午,我拿着支付中心的设计文档,给入职不久的同事讲解目前支付中心系统的应用部署情况。当时同事嗯嗯地点头反应。

下午呢,发现自己设计的有问题,赶紧给予完善。

代码重构方面讲究DRY编程原则。我们在设计流程图、时序图、计划、接口文档等等,同样要遵循这样的原则,以免给别人的理解造成困惑。

 

【原文档截图】

技术分享图片

 

【更改后】

技术分享图片

 

DRY(Don‘t repeat yourself),"不要重复自己"。强调的意思就是在进行编程时相同的代码不要重复写,最好只写一次,然后可以在其他地方直接引用。如此一来,可以提高代码重用率,缩减代码量,同时也有助于提高代码的可读性和可维护性。当需要做出更改时,只需要更改一个地方即可。

随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是共用模块。

文档设计也需要坚持DRY原则--支付中心应用部署结构图完善

标签:14.   重复   重构   同事   就是   info   需要   play   com   

原文地址:https://www.cnblogs.com/buguge/p/9118589.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!