大型源码阅读辅助工具

Sourcetrail

安装

Github地址

下载解压完成以后直接执行install.sh脚本即可安装

如果使用的是IDE的话可以使用相应的插件,以vscode为例,

安装sourcetrail插件,同时设计vsscode以及客户端的端口

和客户端的设置端口需要一致

使用

其中Sourcetrail Project是项目名称,Sourcetrail Project Location是源文件的首地址.

根据不同的语言和方式进行创建项目.

• c/c++ from compliation 如果已经有compile_commands.json文件的可以直接读取这个进行项目构建
• c/c++ from visual studio 通过visual studio帮助构建compile_commands.json文件,需要插件
• Empty C++ source Group 重新创建一个项目

TIP 如果使用的是CMake可以定义标志位CMAKE_EXPORT_COMPILE_COMMANDS生成compile_commands.json文件,如果是Make可以用bear生成该文件,从而实现直接导入s

接着设置c++标准,需要取解析源码的目录路径,文件后缀,头文件路径等,不了解的可以点击图表中的疑问号.配置完成后点击Creat进行构建,

构建完成以后如下图所示

之后就可以联合vscode更加方便的进行代码的阅读了

可以通过vscode中的选项,使得SourceTrail跳出对用内容的结构,反之,在Sourcetrail客户端ctr+鼠标左键后vscode会跳到对应内容