美文网首页程序猿阵线联盟-汇总各类技术干货程序猿葵花宝典
文档设计也需要坚持DRY原则--支付中心应用部署结构图完善

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

作者: buguge | 来源:发表于2018-05-31 19:56 被阅读31次

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

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

代码重构方面讲究DRY编程原则。我们在设计流程图、时序图、应用架构图、计划、接口文档等等,同样要遵循这样的原则。让人一看就能比较明白,必要的环节只需简单的解释即可,而不用每次都重复地讲解一遍。——文档设计得不完整或存在欠缺,也会给别人的理解造成困惑。

【原文档截图】 【更改后】

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

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

相关文章

网友评论

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

本文链接:https://www.haomeiwen.com/subject/trrcsftx.html