修改别人代码的原则

作者: koo叔 分类: 编码与修养 发布时间: 2018-01-02 23:45 编辑

     工作过程中难免会涉及到修改或维护别人写的代码,如:代码原作者请假,离职,或相关的bug落到了你的头上,或用别人写的通用方法不爽时。
        如果碰到修改别人的代码时,需要注意哪些事项呢?
      1)和原作者沟通:当用到了他人写的通用方法,又感觉不爽时。如果原作者还在,最好先沟通好,说明你的需求,尽量让原作者自己来改,切忌事先改好,再对原作者指指点点,一方面,你可能改出来不符合原作者思路,另一方面,可能心情会很不愉快。
      2)保持原作者代码风格:如果要修改的这块代码结构比较良好,逻辑清晰,修改时最好保持原作者风格,如花括弧在左,你也在左,花括弧另起一行,你也另起一行,变量,方法等都保持风格一致,这不仅是对原作者的尊重,也能保持被修改模块的结构和整体性,如果每个人都按自己不同风格改同一模块,那看起来会非常糟糕。
      3)加好注释:这个不用多说,这是应有的职业素养。
      4)必要时重构:如果他人的模块全权移交给你来负责了,代码结构不是特别清晰,原作者也不管了,或不在了,与其修修补补,不如干脆直接重构,以后维护起来,会非常容易。
      5)代码隔离:如果是紧急修复他人代码的bug,要做到代码隔离,意思就是新加的代码与原代码隔离开来,常用的就是用if语句隔离,虽然这样可能导致代码看起来不好看,但在紧急修复时会非常有用,一般不会引起额外bug,等时间允许可以酌情进行重构,充分测试。
        总之,就是要认真,审慎的修改别人代码,同时带着尊敬之心。

如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!

发表评论

你的email不会被公开。必填项已用*标注

更多阅读
标签云