1. 程式人生 > >【轉】編寫高質量代碼改善C#程序的157個建議——建議148:不重復代碼

【轉】編寫高質量代碼改善C#程序的157個建議——建議148:不重復代碼

int 加密 ron enc ren 進行 ring pos crypt

建議148:不重復代碼

如果發現重復的代碼,則意味著我們需要整頓一下,在繼續前進。

重復的代碼讓我們的軟件行為不一致。舉例來說,如果存在兩處相同的加密代碼。結果在某一天,我們發現加密代碼有個小Bug,然後修改了它,卻又忘記了角落裏的某處存在著一份相同的代碼,那麽這個Bug就會隱藏起來。

讓我們重現這個例子:

        void PagerEncrypt()
        {
            //加密代碼
        }

        void AnswerEncrypt()
        {
            //相同的加密代碼
        }

在這段代碼中,方法PagerEncrypt和AnswerEncrypt使用了相同的加密代碼。在實際使用過程中,這兩個方法可能不會靠得如此近,它們甚至可能在不同的命名空間下。糟糕的是,重構人員在進行重構的時候,沒有發現AnswerEncrypt,於是代碼結構變成了:

        void PagerEncrypt()
        {
            Encrypt("密文");
        }

        void AnswerEncrypt()
        {
            //相同的加密代碼
        }

        string Encrypt(string intput)
        {
            string output = string.Empty;
            //加密代碼
            return output;
        }

在開發人員在Encrypt中發現Bug並修正它後,兩端原本相同的加密代碼變成不同的了。一份值正確的,一份是錯誤的。而對於這些代碼的調用者來說,他看到了類似的方法接口,卻沒想到其內部實現是完全不一樣的。這增加了調用者的排錯難度。

所以,對於開發者來說,務必註意不要讓代碼中出現相同的片段,這不僅是為了代碼的整潔,還可以避免更多難以察覺的Bug的出現。

轉自:《編寫高質量代碼改善C#程序的157個建議》陸敏技

【轉】編寫高質量代碼改善C#程序的157個建議——建議148:不重復代碼