文檔設(shè)計也需要堅持DRY原則--支付中心應(yīng)用部署結(jié)構(gòu)圖完善

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

下午呢,發(fā)現(xiàn)自己設(shè)計的有問題,趕緊給予完善。

代碼重構(gòu)方面講究DRY編程原則。我們在設(shè)計流程圖、時序圖、應(yīng)用架構(gòu)圖、計劃、接口文檔等等,同樣要遵循這樣的原則。讓人一看就能比較明白,必要的環(huán)節(jié)只需簡單的解釋即可,而不用每次都重復(fù)地講解一遍。——文檔設(shè)計得不完整或存在欠缺,也會給別人的理解造成困惑。

【原文檔截圖】
【更改后】

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

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,813評論 25 708
  • 先生k閱讀 158評論 0 0
  • 又是欺詐游戲,難道一點就都沒有發(fā)覺么? 估計是因為我太含蓄了吧,畢竟……拆穿也就意味著,失去。 可惜……遲早都要失去的。
    沃雷塔爾閱讀 113評論 0 0