Linux平台下阅读源码的工具链
作者:网络转载 发布时间:[ 2016/5/24 11:33:08 ] 推荐标签:操作系统 Linux
doxygen
上面我们讲的是用vim来查看源代码,但是面对几十万代码的时候,想要看清楚各个结构体之间的关系不是vim能够做到的了.这时候我们需要doxygen来帮手了.
DoxygenisthedefactostandardtoolforgeneratingdocumentationfromannotatedC++sources,
butitalsosupportsotherpopularprogramminglanguagessuchasC,Objective-C,C#,PHP,Java,Python,IDL(Corba,Microsoft,andUNO/OpenOfficeflavors),Fortran,VHDL,Tcl,andtosomeextentD.
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
关于生成图像的选项.doxygen使用dot这个工具来绘图,所以要先执行sudoapt-getinstallgraphviz安装dot.在设置好这个绘图选项之后,doxygen会生成各个结构体的关系,对于类会生成函数调用关系(我没试过,因为只试过C的).
HAVE_DOT(一定要置为YES,后面的选项都依赖这个)
DOT_NUM_THREADS(使用dot绘图的线程数量,越多越快,我一般是设置跟cpu的核数一样)
//以下两个选项跟生成函数调用关系图有关
CALL_GRAPH
CALLER_GRAPH
EXTRACT_ALL//把所有实体都输出到文档,不管它是否能被描述
EXTRACT_STATIC//把静态变量也输出到文档中
EXTRACT_PRIVATE//把私有变量也输出到文档中
给一个结构体关系图,是doxygen生成的.
关于源码搜索路径,默认是搜索本目录的源代码,大部分情况下源码是分布在各个子目录的.
RECURSIVE=YES
默认RECURSIVE是NO,所以记得把它设置为YES,递归搜索子目录.感谢soglad的留言提醒
后一步,在源码根目录执行doxygen,它会自动找到Doxygen配置,根据配置生成文档.
gdb
后一个工具,大名鼎鼎的gdb.分析源码执行流程的好方式的是运行它,然后一步步执行.用来观察它好的工具当然是gdb了(针对C/C++).
gdb的使用我也不打算造轮子,直接参考用GDB调试程序,这篇写的很好,通俗易懂.
后记
以上是我在阅读源码的时候使用的Linux工具,三剑客vim+ctags+cscope,两板斧doxygengdb,足以驰骋源代码的江湖.
以上工具,vim和gdb是难学的,学习曲线很陡峭.但是学好之后,能守得云开见月明.
参考文章,感谢帮助
vi/vim使用进阶:程序员的利器–cscope
本文内容不用于商业目的,如涉及知识产权问题,请权利人联系SPASVO小编(021-61079698-8054),我们将立即处理,马上删除。
相关推荐
Linux下开源的DDR压力测试工具曝Linux恶意软件:让树莓派设备挖掘数字货币linux系统中不同颜色的文件夹及根目录介绍软件测试工程师必知必会Linux命令Linux下DNS服务器配置如何成为不可替代的Linux运维工程师?详解Linux进程(作业)的查看和杀死Linux 日志定时轮询流程详解比特币勒索病毒不只Windows系统有,Linux版的来了Linux日志定时轮询流程详解Linux iommu和vfio概念空间解构Linux系统如何低于TCP洪水攻击Linux无损调整分区大小Linux下防火墙配置实例Linux使用Jexus托管Asp.Net Core应用程序Linux中引号的那些事
更新发布
功能测试和接口测试的区别
2023/3/23 14:23:39如何写好测试用例文档
2023/3/22 16:17:39常用的选择回归测试的方式有哪些?
2022/6/14 16:14:27测试流程中需要重点把关几个过程?
2021/10/18 15:37:44性能测试的七种方法
2021/9/17 15:19:29全链路压测优化思路
2021/9/14 15:42:25性能测试流程浅谈
2021/5/28 17:25:47常见的APP性能测试指标
2021/5/8 17:01:11热门文章
常见的移动App Bug??崩溃的测试用例设计如何用Jmeter做压力测试QC使用说明APP压力测试入门教程移动app测试中的主要问题jenkins+testng+ant+webdriver持续集成测试使用JMeter进行HTTP负载测试Selenium 2.0 WebDriver 使用指南