Linux源代码分析工具链(2)

nmap <C-@>e :cs find e <C-R>=expand("<cword>")<CR><CR>

nmap <C-@>f :cs find f <C-R>=expand("<cfile>")<CR><CR>

nmap <C-@>i :cs find i ^<C-R>=expand("<cfile>")<CR>$<CR>

nmap <C-@>d :cs find d <C-R>=expand("<cword>")<CR><CR>

上面的配置即把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里面的配置可谓又臭又长,你绝对不会有读完它的欲望。所以我给出几个关键的配置项,到时候搜索它修改即可

这是针对各种语言优化输出的选项,默认都是NO,因为它不清楚你用的是什么语言(话说看一下后缀不就知道了吗…)

OPTIMIZE_OUTPUT_FOR_C

OPTIMIZE_OUTPUT_JAVA

OPTIMIZE_FOR_FORTRAN

OPTIMIZE_OUTPUT_VHDL

这个是生成文档的类型的选项,默认生成html和latex,共支持六种类型的文档,每种类型的生成配置也是很多,具体根据需要配置

GENERATE_HTML

GENERATE_LATEX

GENERATE_RTF

GENERATE_XML

GENERATE_DOCBOOK

GENERATE_MAN

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/15996.html