如何尽快的上手代码
前言
程序员跳槽是一件再正常不过的事情,但每次跳槽后都将面临一个问题,接手代码!因为这就是我们的工作,是必须直面的。所以今天就从我自己出发,说说我怎么个开始接手代码的。先说说情况,换到新公司,原来做iOS的人,都走了,其中有个之前做wp 的同学,转到了iOS,接手项目也才两个月左右。我来这后,基本没人跟我说业务逻辑,没人跟我说项目情况,有的就是一份代码,真的就一份代码,连需求文档,UI这些都没给过来,(,也许还没转正吧,不想吐槽),所以,接下来只能靠自己了。
准备工作
-
1、公司上线或者正在开发的APP,可用的。作为开发人员,首先你得对自己将要做的东西有个了解吧,所以对APP的把玩肯定是少不了。在把玩中,去分析各个功能的实现,对我而言,我们的APP做的是电商平台,所以很多页面都是用H5展示内容,通过 webview 来实现 OC和js的交互。因为有聊天功能,用了xmpp框架,每在一个模块,就试着去分析这个模块用到的技术,怎样去实现,因为这些都只是在脑子里想,所以我们可以很快的思考,并且保证思维的连续。这一步,我们肯定没必要花太多时间,但是你得基本过一次,对整个APP有大致的了解,不然,进入到代码的世界,发现难以很快将代码和UI联系起来。
-
2、纸、笔或者在线笔记等一切可以做记录的工具。想来大家都知道,看代码是永远学不会编程的,因为编程应该是一项需要缜密逻辑思维能力的工作。为了保证我们逻辑的流畅,我还是喜欢通过使用文字进行简要的说明,将一些逻辑串联起来。这样,我们回头看的时候,就能很快回忆起来各个模块之间的关系,便于形成整体的思路,而不是脑袋里过了一遍就没了,下次又要花好长时间才能将各个逻辑串联起来。
-
3、重要的事情说三遍!耐心、耐心、耐心、坚持、坚持、坚持 如果你运气好,之前的工程师是有点代码洁癖或者对自己有要求高一点什么的,比如说项目结构完整清晰,命名规范,那么恭喜你,你是幸运的。不然你可能会遇见我现在的情形,接手一份烂代码,不管是整个项目的结构,类命名,变量命名都是随心所欲,没有遵循一套编码规范,那么肯定就得多花一点点时间了。千万不要想着推到重写,因为那是不现实的。没时间,没精力,也不能保证稳定性,推到重写的想法千万要扼杀在摇篮中,且不能复生!
正题
下面说说我们怎么开始:
-
1、一般来说,我们将
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
作为我们的代码入口,(虽然它的确不是,入口肯定main 函数),所以分析就从 AppDelegate,在这里基本可以将之前玩这个app想到的UI界面的实现联系起来。这个类里还有对app 整个生命周期的管理,比如进入后的操作啊,别的app 通过 scheme Url 启动本app 什么的。 -
2、接下来就是对代码的粗浏览。既然我们知道了代码入口,那么顺藤摸瓜就好,按照模块来。看一个类的代码也要注意,如果类的命名不怎么好理解,这个时候就别吝啬自己动手记下来,如果有考虑修改,也可以做个标记,以后项目上手了,就直接动刀子,改成符合规范、命名清晰的。再次,对于看代码,需要粗看,就是看方法,看看这个类都干了什么,怎么跟其他的类进行数据交互等等这些。不要钻进去研究每句代码的实现,我们需要的是快速上手,所以,对代码有个整体的认识。
-
3、接下来就是上手代码了。到这一步的时候,肯定是我们对代码有了一定程度的了解。我们需要在实践中去熟悉代码,一行行的看代码,只会让你感觉疲倦,如果有修改bug,或者新的需求开发任务,那么我们就可以充分利用起来,一边写代码,然后对关联类加以了解,这个时候,一行行的看代码,就不会疲倦了,因为有目的性,完成之后也有成就感。而代码就是在这样一点点的积累中熟悉起来的。
-
4、随手改代码。在看代码的过程中,可能会遇到很多没有注释,语义又不明确的代码,这个时候,我就只有静下心来,一点点的琢磨代码,然后去调试,在弄懂了后,记得加上注释,这是对自己最好的投资,避免你再重头看代码,也便于你回忆。另外就是对于不规范的代码,看情况去改。有些代码是可以随手就改了的,不要等着哪天有时间,再去修改,比如 没用的注释,没用的方法,一些过时的系统方法等,这些都是你很确定改了也不会出问题代码。还有一些,可能就需要仔细点的去修改,不建议在初期修改,可以在彻底上手项目,对业务也比较熟悉后,进行重构。也不要在这个时候去考虑性能啊什么的,我们需要的是稳定。这个不了解,不过可以到我以后重构的时候再来说。
总结
接手一份烂代码,可能会让你很头痛,但是,如果能把这份烂代码变成优雅的代码,或者说规范、易懂、简洁的代码,这就体现着自己的能力。在这个改造的过程中,自己的能力也正一点点的提高。作为一个接近两年工作经验的程序员,应该开始站在一个更高的角度来看待工作和自己,不然一直站在原来那个位置,享受着安逸,不接受挑战,自然也不会有提高。
-----------------------我是分割线-------------------------
如果有不对的地方,请各位请拍砖