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

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

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

代碼重構(gòu)方面講究DRY編程原則堪滨。我們?cè)谠O(shè)計(jì)流程圖、時(shí)序圖蕊温、應(yīng)用架構(gòu)圖袱箱、計(jì)劃遏乔、接口文檔等等,同樣要遵循這樣的原則发笔。讓人一看就能比較明白盟萨,必要的環(huán)節(jié)只需簡(jiǎn)單的解釋即可,而不用每次都重復(fù)地講解一遍了讨∧砑ぃ——文檔設(shè)計(jì)得不完整或存在欠缺,也會(huì)給別人的理解造成困惑前计。

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

DRY(Don't repeat yourself)胞谭,"不要重復(fù)自己"。強(qiáng)調(diào)的意思就是在進(jìn)行編程時(shí)相同的代碼不要重復(fù)寫男杈,最好只寫一次丈屹,然后可以在其他地方直接引用。如此一來伶棒,可以提高代碼重用率旺垒,縮減代碼量,同時(shí)也有助于提高代碼的可讀性和可維護(hù)性肤无。當(dāng)需要做出更改時(shí)先蒋,只需要更改一個(gè)地方即可。

隨意復(fù)制和粘貼代碼舅锄,必然會(huì)導(dǎo)致代碼的重復(fù)鞭达,在以后需要修改時(shí),需要修改所有的副本皇忿,容易遺漏畴蹭。必要時(shí)抽取共性方法,或者抽象公共類鳍烁,甚至是共用模塊叨襟。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市幔荒,隨后出現(xiàn)的幾起案子糊闽,更是在濱河造成了極大的恐慌,老刑警劉巖爹梁,帶你破解...
    沈念sama閱讀 211,348評(píng)論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件右犹,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡姚垃,警方通過查閱死者的電腦和手機(jī)念链,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,122評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人掂墓,你說我怎么就攤上這事谦纱。” “怎么了君编?”我有些...
    開封第一講書人閱讀 156,936評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵跨嘉,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我吃嘿,道長(zhǎng)祠乃,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,427評(píng)論 1 283
  • 正文 為了忘掉前任唠椭,我火速辦了婚禮跳纳,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘贪嫂。我一直安慰自己寺庄,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,467評(píng)論 6 385
  • 文/花漫 我一把揭開白布力崇。 她就那樣靜靜地躺著斗塘,像睡著了一般。 火紅的嫁衣襯著肌膚如雪亮靴。 梳的紋絲不亂的頭發(fā)上馍盟,一...
    開封第一講書人閱讀 49,785評(píng)論 1 290
  • 那天,我揣著相機(jī)與錄音茧吊,去河邊找鬼贞岭。 笑死,一個(gè)胖子當(dāng)著我的面吹牛搓侄,可吹牛的內(nèi)容都是我干的瞄桨。 我是一名探鬼主播,決...
    沈念sama閱讀 38,931評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼讶踪,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼芯侥!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起乳讥,我...
    開封第一講書人閱讀 37,696評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤柱查,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后云石,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體唉工,經(jīng)...
    沈念sama閱讀 44,141評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,483評(píng)論 2 327
  • 正文 我和宋清朗相戀三年汹忠,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了酵紫。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片告嘲。...
    茶點(diǎn)故事閱讀 38,625評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡错维,死狀恐怖奖地,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情赋焕,我是刑警寧澤参歹,帶...
    沈念sama閱讀 34,291評(píng)論 4 329
  • 正文 年R本政府宣布,位于F島的核電站隆判,受9級(jí)特大地震影響犬庇,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜侨嘀,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,892評(píng)論 3 312
  • 文/蒙蒙 一臭挽、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧咬腕,春花似錦欢峰、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,741評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至举反,卻和暖如春懊直,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背火鼻。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評(píng)論 1 265
  • 我被黑心中介騙來泰國(guó)打工室囊, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人魁索。 一個(gè)月前我還...
    沈念sama閱讀 46,324評(píng)論 2 360
  • 正文 我出身青樓融撞,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親蛾默。 傳聞我的和親對(duì)象是個(gè)殘疾皇子懦铺,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,492評(píng)論 2 348

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

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 171,757評(píng)論 25 707
  • 先生k閱讀 154評(píng)論 0 0
  • 又是欺詐游戲,難道一點(diǎn)就都沒有發(fā)覺么支鸡? 估計(jì)是因?yàn)槲姨盍税啥睿吘埂鸫┮簿鸵馕吨ァ?可惜……遲早都要失去的牧挣。
    沃雷塔爾閱讀 105評(píng)論 0 0