修改别人代码的原则
2018-01-03 23:00
981 查看
工作过程中难免会涉及到修改或维护别人写的代码,如:代码原作者请假,离职,或相关的bug落到了你的头上,或用别人写的通用方法不爽时。
如果碰到修改别人的代码时,需要注意哪些事项呢?
1)和原作者沟通:当用到了他人写的通用方法,又感觉不爽时。如果原作者还在,最好先沟通好,说明你的需求,尽量让原作者自己来改,切忌事先改好,再对原作者指指点点,一方面,你可能改出来不符合原作者思路,另一方面,可能心情会很不愉快。
2)保持原作者代码风格:如果要修改的这块代码结构比较良好,逻辑清晰,修改时最好保持原作者风格,如花括弧在左,你也在左,花括弧另起一行,你也另起一行,变量,方法等都保持风格一致,这不仅是对原作者的尊重,也能保持被修改模块的结构和整体性,如果每个人都按自己不同风格改同一模块,那看起来会非常糟糕。
3)加好注释:这个不用多说,这是应有的职业素养。
4)必要时重构:如果他人的模块全权移交给你来负责了,代码结构不是特别清晰,原作者也不管了,或不在了,与其修修补补,不如干脆直接重构,以后维护起来,会非常容易。
5)代码隔离:如果是紧急修复他人代码的bug,要做到代码隔离,意思就是新加的代码与原代码隔离开来,常用的就是用if语句隔离,虽然这样可能导致代码看起来不好看,但在紧急修复时会非常有用,一般不会引起额外bug,等时间允许可以酌情进行重构,充分测试。
总之,就是要认真,审慎的修改别人代码,同时带着尊敬之心。
如果碰到修改别人的代码时,需要注意哪些事项呢?
1)和原作者沟通:当用到了他人写的通用方法,又感觉不爽时。如果原作者还在,最好先沟通好,说明你的需求,尽量让原作者自己来改,切忌事先改好,再对原作者指指点点,一方面,你可能改出来不符合原作者思路,另一方面,可能心情会很不愉快。
2)保持原作者代码风格:如果要修改的这块代码结构比较良好,逻辑清晰,修改时最好保持原作者风格,如花括弧在左,你也在左,花括弧另起一行,你也另起一行,变量,方法等都保持风格一致,这不仅是对原作者的尊重,也能保持被修改模块的结构和整体性,如果每个人都按自己不同风格改同一模块,那看起来会非常糟糕。
3)加好注释:这个不用多说,这是应有的职业素养。
4)必要时重构:如果他人的模块全权移交给你来负责了,代码结构不是特别清晰,原作者也不管了,或不在了,与其修修补补,不如干脆直接重构,以后维护起来,会非常容易。
5)代码隔离:如果是紧急修复他人代码的bug,要做到代码隔离,意思就是新加的代码与原代码隔离开来,常用的就是用if语句隔离,虽然这样可能导致代码看起来不好看,但在紧急修复时会非常有用,一般不会引起额外bug,等时间允许可以酌情进行重构,充分测试。
总之,就是要认真,审慎的修改别人代码,同时带着尊敬之心。
相关文章推荐
- 我的第十个java程序--(其实是修改别人的web代码{springmvc+mybatis},知道了原理后其实一切都变的很简单)
- 月历修改了一下别人的代码自己写的一个新的月历
- 修改别人的代码是一种找虐
- 修改别人写的Hibernate数据库操作代码
- 修改了别人的代码、优化前与优化后的对比,唉,写个好代码真不容易啊
- github上修改别人的代码并上传
- 修改了别人的代码、优化前与优化后的对比,唉,写个好代码真不容易啊
- 修改了别人的代码、优化前与优化后的对比,唉,写个好代码真不容易啊
- SpringAOP实现的用户权限管理【修改了别人的代码,感谢原作者!】
- 问题记录:想要替换别人的代码,但是没办法或不能修改别人的代码
- Git-修改别人的代码
- 学习了别人的运维平台的代码,对其中的一段代码做了小修改
- 另一种希望别人无法修改js的代码
- 另一种希望别人无法修改js的代码
- 修改别人的jar里的少量代码来满足特定需求
- 阅读代码和修改别人代码的一些技巧以及注意事项
- 阅读代码和修改别人代码的一些技巧以及注意事项
- 关于修改别人代码,出现的反编译问题!proguard , at com.*.*.hall.a.h.a(Unknown Source)
- 修改了别人的代码、优化前与优化后的对比,唉,写个好代码真不容易啊
- 如何修改python IDLE代码及语法主题 配色——拷贝的是别人喜欢的,来学会调试自己喜欢的颜色吧