修改別人代碼的原則_工作

來源:互聯網
上載者:User

     工作過程中難免會涉及到修改或維護別人寫的代碼,如:代碼原作者請假,離職,或相關的bug落到了你的頭上,或用別人寫的通用方法不爽時。
        如果碰到修改別人的代碼時,需要注意哪些事項呢。
      1)和原作者溝通:當用到了他人寫的通用方法,又感覺不爽時。如果原作者還在,最好先溝通好,說明你的需求,盡量讓原作者自己來改,切忌事先改好,再對原作者指指點點,一方面,你可能改出來不符合原作者思路,另一方面,可能心情會很不愉快。
      2)保持原作者代碼風格:如果要修改的這塊代碼結構比較良好,邏輯清晰,修改時最好保持原作者風格,如花括弧在左,你也在左,花括弧另起一行,你也另起一行,變數,方法等都保持風格一致,這不僅是對原作者的尊重,也能保持被修改模組的結構和整體性,如果每個人都按自己不同風格改同一模組,那看起來會非常糟糕。
      3)加好注釋:這個不用多說,這是應有的職業素養。
      4)必要時重構:如果他人的模組全權移交給你來負責了,代碼結構不是特別清晰,原作者也不管了,或不在了,與其修修補補,不如乾脆直接重構,以後維護起來,會非常容易。
      5)代碼隔離:如果是緊急修複他人代碼的bug,要做到代碼隔離,意思就是新加的代碼與原代碼隔離開來,常用的就是用if語句隔離,雖然這樣可能導致代碼看起來不好看,但在緊急修複時會非常有用,一般不會引起額外bug,等時間允許可以酌情進行重構,充分測試。
        總之,就是要認真,審慎的修改別人代碼,同時帶著尊敬之心。

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.