如何提高阅读源代码的效率
记得在开源流行之前,我看过的代码紧限于所参与的项目,能有个几万行就不错哩。后来很多优秀开源项目都相继蹦出来了,阅读的代码量那叫一个大呀!不得不看。我现在掉到android这个大坑里,每天都要看很多源代码。以前做过J2EE,看Struts2、Lucene、OSWorkflow、iText等项目的源码,动机有三:文档不足、找问题的原因、好奇。当时有个项目用到了Dojo,这家伙可以说是源码最多的开源Javascript框架了,文档却严重不足,也没什么人用,只能看源码了。
要想快速并高效地阅读源码,一定要有好方法,不然看着会挺费劲,当然,用什么方法取决于具体的情况。我就把自己总结的方法给大家show一下,互相交流交流:
1、一边阅读代码一边写注释。这是我用过的最好的方法,对代码理解得更深入,看一些重要代码或者特别难懂的代码时挺有用。更何况,注释也是一种文档嘛。
2、一边阅读代码一边绘制UML。这个方法适用于类之间的关系较复杂和调用层次较深的情况,我一般都是先绘制顺序图,然后为顺序图中的类绘制关系图。
3、通过Debug来跟踪程序的主要执行过程,这样就可以分清主次了,阅读的时候更有针对性。
4、类的快速阅读。先弄清楚它在继承链中的位置,看看它的内部状态,也就是成员变量,一般来说,类的对外接口都是对成员变量的访问、加工、代理等,然后看看它的对外接口,也就是公有成员函数,识别核心的一个或多个函数,这时候你应该可以大概了解这个类的职责或作用了。可能这个类是某个设计模式中的一个组成部分,所以,设计模式的掌握对代码的快速阅读也是很有帮助的。
5、带着问题去阅读。比如想了解android中的消息机制,那么看看Looper、Handler、MessegeQueue这几个类就可以了,其他的不要去看,要不然就跑题了。
下面列几个阅读源码时所处的情景,在特定场景下用哪些方法:
不太熟悉业务逻辑,还不是很清楚它是干啥的,可以用3、5。
代码量很大,有几十万行,甚至百万行,可以用2、3、5。
你无法看见程序的运行过程,比如没有用户界面,也有可能是无法运行的,可以用3、5。
设计复杂,用了大量的设计模式,调用链很深,可以用1、2、3、4、5。
时间有限,没有那么多时间让你看源码,可以用3、5。
记得在使用MindManager之前,考虑问题的解决办法的过程经常会被各种事件打断,回过头来再继续时总会有些偏差,甚至忘记了之前想到的关键地方,所以,有时候也会一边想一边记,但总觉得这个过程不够高效,一段时间后,记录的内容连自己也看不懂,有的根本就找不到了,无形的价值随之流失。
其实我也一直在找可替代的方法,尤其是类似的软件,感觉都不太合适,大多数都是些类似便筏、网络笔记本的工具。无意中见到一位同事边看电子书边做笔记,所使用的软件让我眼前一亮,它能以树状层次呈现所有节点或者步骤,有点类似平时看到的大纲,不过它的结构更清晰、更灵活,而且每个节点可以关联图片、文档、详细说明等资源。这类软件叫思维导图软件,我下载了一个功能比较强大的,它就是MindManager,界面的风格非常像office系列软件。
它的使用很简单,当新建一个导图后,先确定主要或核心主题的内容,然后就可以从该主题中扩展出更多的子主题,每个主题可以关联各种图标,比如紧急程度、重要性、完成进度等,每个主题的内容一般都是概要信息,简短明晰,如果需要为这个主题做一些解释,那么可以为它增加注释。
使用MindManager一段时间后,思考问题的过程也有了提高,变得更加清晰,更加有条理。
当我们打开电脑做一些事后,任务栏中就会有若干已打开应用程序的窗口,在它们之间切换,绝大部分人使用下面两种方式:
1、使用Tab键
#NoEnv ; Recommended for performance and compatibility with future AutoHotkey releases.
SendMode Input ; Recommended for new scripts due to its superior speed and reliability.
SetWorkingDir %A_ScriptDir% ; Ensures a consistent starting directory.
SetTitleMatchMode 2
Activate(t)
{
IfWinActive,%t%
{
WinMinimize
return
}
SetTitleMatchMode 2
DetectHiddenWindows,on
IfWinExist,%t%
{
WinShow
WinActivate
return 1
}
return 0
}
ActivateAndOpen(t,p)
{
if Activate(t)==0
{
Run %p%
WinActivate
return
}
}
#a::ActivateAndOpen("Microsoft Outlook","outlook.exe")
#b::ActivateAndOpen("UltraEdit","C:\Program Files\UltraEdit\UltraEdit.exe")
#c::Activate("UltraEdit")
这里简单地说一下,开头的几行是初始化语句,然后定义了两个函数:Activie和ActiveAndOpen,后者会调用前者。Activie的作用是激活指定标题(通过参数t传递,也可以是标题的一部分,只要能唯一识别该窗口即可)的窗口,如果当前窗口已经是待激活的窗口,那么隐藏它,如果窗口不存在的化,并不会打开相应的应用程序,也就是什么都不做,而ActivieAndOpen会在指定窗口不存在的情况下打开相应的应用程序,它的第一个参数是窗口标题,第二个参数就是应用程序的全路径。这两个函数定义后面的3条语句就是调用的示例,每一行就是一次函数调用,第一个字母#表示用Windows键作为快捷键的基本键,因为这个键本身所关联的快捷键比较少,所以建议大家都用这个键,第二个字母就是要和Windows键组合的键,比如#a就代表 Win+a作为快捷键,两个冒号后面定义的是要用这个快捷键做什么,这里我们的目的就是调用前面定义的两个函数之一,比如第一行用Win+a打开Outlook邮箱,如果还未打开就会启动它。把脚本内容拷贝到记事本中,保存成后缀为ahk的文件,然后点击这个文件,就可以在托盘中看到一个字母为H的绿色图标,至此,我们就可以通过预定义的快捷键进行窗口切换了。
GoF著作中未提到的设计模式(6):Specification
posted @ 2011-09-15 18:00 West_Link 阅读(901) | 评论 (1) 编辑
GoF著作中未提到的设计模式(5):Object Pool
posted @ 2011-09-05 11:19 West_Link 阅读(1527) | 评论 (11) 编辑
GoF著作中未提到的设计模式(4):Double Dispatch
posted @ 2011-07-26 10:13 West_Link 阅读(1298) | 评论 (2) 编辑
GoF著作中未提到的设计模式(3):Null Object
posted @ 2011-07-08 09:44 West_Link 阅读(1730) | 评论 (13) 编辑
GoF著作中未提到的设计模式(2):Interceptor
posted @ 2011-06-22 09:45 West_Link 阅读(1247) | 评论 (13) 编辑
GoF著作中未提到的设计模式(1): Archetype
posted @ 2011-06-16 10:27 West_Link 阅读(1405) | 评论 (9) 编辑