使用SourceTrail代替SourceInsight

使用SourceTrail代替SourceInsight_第1张图片

SourceTrail是一款开源、免费的交互式源代码浏览器,它能够通过索引你的文件以及收集项目的结构数据来简化你在现存代码中查看。目前支持的语言种类:C、C++、Java、Python,并且可以自定义语言类型。

源代码浏览器的作用比较大,从一定程度上能够简化你对一个项目源代码的了解过程,源代码浏览器一般情况下都能够针对某个变量或者方法等进行全项目的查找索引等,比较有名的是SI但是收费,而且功能很丰富学习难度大。

创建SourceTrail项目

使用SourceTrail代替SourceInsight_第2张图片

启动SourceTrail出现的是开始页面,从开始页面可以进行项目的创建或者打开项目。此处以一个DirectX 11的项目为例!

1、点击New Project按钮,创建一个新项目;

使用SourceTrail代替SourceInsight_第3张图片

2、弹出项目创建向导,根据项目的不同该向导的创建步骤也不同,填写项目名称及项目创建目录,并点击Add Source Group添加文件到项目中;

使用SourceTrail代替SourceInsight_第4张图片

使用SourceTrail代替SourceInsight_第5张图片

3、选择项目语言类型以及以何种方式导入项目;

如果使用Cmake、Make、QtCreator作为编译环境,可以导出一个clang JSON编译数据库并命名为compile_commands.json,一个编译数据库包含对编一个项目所有的必要信息,包含源文件、包含路径和编译标志。通过使用编译数据库可以轻松创建SourceTrail项目,坐着推荐使用该方法。

导出编译数据库:

  1. 对于CMake通过定义CMAKE_EXPORT_COMPILE_COMMANDS标志位实现;
  2. 对于Make工程使用Bear,该工具在一个构建进程中生成一个compile_commands.json;
  3. 对于Qt Creator通过选择”Build”菜单中的”Generate Compilation Database”选项;

如果使用Visual Studio导出一个编译数据库需要使用对应的Visual Studio插件,可以通过选择C++、C、Java、Custom进行查看创建工程的方法。

使用SourceTrail代替SourceInsight_第6张图片

4、点击Next按钮,并填写Compilation_Database.json文件、头文件路径、排除的文件路径等;

使用SourceTrail代替SourceInsight_第7张图片

5、点击Next按钮,填写预编译的头文件路径和标志;

使用SourceTrail代替SourceInsight_第8张图片

6、点击Next后便回到创建项目页,并且在一个项目中可以创建多个SourceGroup;

使用SourceTrail代替SourceInsight_第9张图片

7、点击Create按钮创建项目,点击弹出窗口中的Start进行索引文件;

使用SourceTrail代替SourceInsight_第10张图片

在这个过程中往往会出现错误,大部分是不能正确识别文件中的内容抛出的异常。

 

你可能感兴趣的:(工作效率)