原文:http://blog.jobbole.com/101322/ 前言看源代码是一个程序员必须经历的事情,也是可以提升能力的一个捷径.个人认为: 要完全掌握一个软件的方法只有阅读源码。在Windows下有sourceinsight这个源码阅读软件(虽然我没用过,但是网上评 ...
原文:http://blog.jobbole.com/101322/
前言
看源代码是一个程序员必须经历的事情,也是可以提升能力的一个捷径.个人认为: 要完全掌握一个软件的方法只有阅读源码。
在Windows下有sourceinsight这个源码阅读软件(虽然我没用过,但是网上评价还不错),由于我是个Linuxer,并不喜欢用Windows,所以自然是选择在Linux下阅读源码的工具了.
下面我将逐一介绍在Linux下阅读源码的工具.
源码阅读三剑客.vim配合ctags和cscope,足以在源代码里面自由翱翔,在函数和变量间自由跳转.
安装
sudo apt-get install vim ctags cscope |
使用
vim
vim的使用就略过了,网上资料很多,不是一篇文章能说完的,未来我可能会写一篇vim的使用心得。推荐一篇《简明 Vim 练级攻略》,看完就差不多会用了.
ctags的使用很简单,vim已经内置了对ctags的支持
首先在源代码根目录执行ctags -R
,递归的为源码建立tags,在根目录会生成一个Tags的文件,存放各种函数和变量的tag,便于跳转
- 使光标在函数或变量上,
Ctrl + ]
即可跳转到其定义处 Ctrl + t
可以回到你跳转之前的位置
对于简单的代码,ctags就够用了,但是对于比较复杂的代码来说,ctags显得有点力不从心,于是,下一位剑客就登场了.
cscope
vim同样内置了对cscope的支持.
首先在源代码根目录执行cscope -Rbq
,就会生成cscope.out文件(索引数据库)
- -R: 在生成索引文件时,搜索子目录树中的代码
- -b: 只生成索引文件,不进入cscope的界面
- -q: 生成cscope.in.out和cscope.po.out文件,加快cscope的索引速度
然后在vim中执行:cs add cscope.out
,添加数据库.
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" | 上面的配置即把Ctrl + @
作为:cs find
的快捷键,也就是说要查找某个函数名,只需要把光标放在函数名上,按下Ctrl + @ + s
即可,简直不能更方便.而且你可以自己修改配置,映射到自己觉得舒服的快捷键上.
本着不重复造轮子的原则,我就简单的写了cscope的基本用法,其实基本上就够用了,进阶的用法参考这篇文章vi/vim使用进阶: 程序员的利器 – cscope
doxygen
上面我们讲的是用vim来查看源代码,但是面对几十万代码的时候,想要看清楚各个结构体之间的关系就不是vim能够做到的了.这时候我们就需要doxygen来帮手了.
Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D.
doxygen是一个根据源代码生成文档的工具,这货虽然主要是给C++用的,但是它也对其他语言有支持.安装直接去官网,按照其指导安装即可。
下面介绍一下doxygen的使用方法.
首先,在源代码根目录执行doxygen -g
,然后在根目录就会突然冒出一个名为Doxyfile的文件,这个文件就是doxygen生成文档的配置文件了.
那么,重点来了,怎么配置这个文件,默认的配置是根据代码生成各个结构体的成员数据,然后生成html和latex两个文件夹,分别是网页和latex文档.
说实话,默认生成的文档并没有什么卵用,除了让你更方便的看到各个结构体的组成成员.我们关心的是各个结构体之间的关系,这是针对C而言的.对与C++和java而言,关心的是类之间的关系.所以,默认的配置肯定是要修改的.至于怎么改,看官方文档.
当然了,如果这篇文章唯一给出的建议就是看文档,那这篇文章有什么意义呢.大家都知道看文档可以解决问题,但是时间成本太高,而且是英文的.写这篇文章的目的是分享自己学习得到的经验,让大家少走弯路,如果不能解决你的问题,只能去看文档了
接下来我根据我自己看文档用到的配置跟大家解释一下.
首先,Doxygen里面的配置可谓又臭又长,你绝对不会有读完它的欲望.所以我给出几个关键的配置项,到时候搜索它修改即可
*特别声明:以上内容来自于网络收集,著作权属原作者所有,如有侵权,请联系我们:
admin#shaoqun.com
(#换成@)。