1. 程式人生 > >文檔設計也需要堅持DRY原則--支付中心應用部署結構圖完善

文檔設計也需要堅持DRY原則--支付中心應用部署結構圖完善

p s block style bubuko display 圖片 中心 更改 情況

今天上午,我拿著支付中心的設計文檔,給入職不久的同事講解目前支付中心系統的應用部署情況。當時同事嗯嗯地點頭反應。

下午呢,發現自己設計的有問題,趕緊給予完善。

代碼重構方面講究DRY編程原則。我們在設計流程圖、時序圖、計劃、接口文檔等等,同樣要遵循這樣的原則,以免給別人的理解造成困惑。

【原文檔截圖】

技術分享圖片

【更改後】

技術分享圖片

DRY(Don‘t repeat yourself),"不要重復自己"。強調的意思就是在進行編程時相同的代碼不要重復寫,最好只寫一次,然後可以在其他地方直接引用。如此一來,可以提高代碼重用率,縮減代碼量,同時也有助於提高代碼的可讀性和可維護性。當需要做出更改時,只需要更改一個地方即可。

隨意復制和粘貼代碼,必然會導致代碼的重復,在以後需要修改時,需要修改所有的副本,容易遺漏。必要時抽取共性方法,或者抽象公共類,甚至是共用模塊。

文檔設計也需要堅持DRY原則--支付中心應用部署結構圖完善