Sourcetrail

Sourcetrail提供源码管理功能，可以在软件创建源码项目，可以设置项目索引，方便以后在这款软件处查询源码，源码内容都是可以复制使用的，无论是个人还是企业都可以通过这款软件建立源码库，您可以在软件创建c++项目，可以创建C语言项目，可以创建Java项目，可以创建Python项目，提供类似思维导图的方式可视化您的代码项目，代码项目都是可以建立索引的，鼠标点击相关的来源组就可以展开项目查看源码，索引建立完毕就可以在图形化的界面查看索引符号，在搜索栏可以很容易地访问所有的索引符号。使用它来查找您要研究的所有类和函数！

Sourcetrail软件功能

1 为您的源代码编制索引

Sourcetrail的深入静态分析可以找到你的源代码文件中的所有定义和引用。要启动静态代码分析器，你可以导入现有的构建配置或选择手动项目设置。

2 查找任何符号

使用Sourcetrail的搜索栏可以快速找到整个代码库中的任何符号。模糊的代码搜索引擎只需敲几下键盘就能给你提供最佳匹配。

3 视觉上探索依赖关系

图形可视化提供了对任何感兴趣的类、方法、字段等及其所有关系的快速概述。依赖关系图是完全互动的。通过关注相关的节点和边，使用它在代码库中移动。

4 浏览你的源代码

最后，代码视图在一个排列整齐的代码片断列表中保存了焦点元素的所有实现细节。进一步作用域和突出局部变量，或关注任何其他遇到的引用或元素。

5 连接你的源代码编辑器

通过插件将Sourcetrail与您喜爱的源代码编辑器同步。这样就可以在编写和探索之间轻松切换。

Sourcetrail软件特色

Sourcetrail是：

自由

离线工作

在Windows，macOS和Linux上运行

支持C，C ++，Java和Python

提供一个SDK（SourcetrailDB）来编写自定义语言扩展

可连接的编辑器：

Atom，Clion，Eclipse，Emacs，IntelliJ IDEA，Neovim，PyCharm，QtCreator，Sublime Text，Vim，Visual Studio，Visual Studio Code;

Sourcetrail使用说明

1、您正在查看Sourcetrail的代码视图，该视图通常显示源代码，但是每次加载新项目时，它都会提供一个快速摘要，以估算项目的大小。 这是一个相当小的项目。 如下面的数字所示，它仅包含几百行代码。

2、如您所知，“代码视图”显示了与您当前处于活动状态的符号相关的代码片段。 这些摘录结合一些上下文来显示相关行。

如果您在代码段上下文中发现了一些有趣的内容，则可以通过单击鼠标左键激活该符号。 这样，您就可以更深入地研究代码库。

3、您是否想过生命，宇宙和一切的意义是什么？ 单击相应的符号进行查找。请单击“代码视图”右上角的“片段列表模式”按钮。

4、这是Sourcetrail教程的中心。 在这里，您可以短途旅行，探索Sourcetrail的不同部分。 最重要的是：您将了解Sourcetrail的所有不同部分是如何交互的。

下面的函数引用了所有可用的教程。 因此，选择一个并立即采取行动。

5、我们刚刚谈到了Sourcetrail，它为重要的代码行提供了上下文。

但是感觉好像这里缺少什么。 什么是“ the_question”？ 它是从哪里来的？

3-扩大范围

您看到此代码段的第一行了吗？ 我的意思是说，只有两个点作为行号，并且显示为“ deep_thought”。 实际上，这就是封装代码段的函数范围的名称。 通过单击该行，您可以告诉Sourcetrail扩展视图以显示整个范围。

6、没有更多内容

在此阶段，您将看到整个文件，并且无法扩展其他上下文。

在本简介的最后部分，请看一下在哪里使用了“ unrelated_but_very_important（）”函数

7、6-片段和文件

似乎在同一文件中的两个不同位置调用了此函数。 当两个不同的片段位于同一文件中时，它们共享一个文件框。 左侧的行号指示每个代码段在文件中的位置。

8-合并片段

每个摘录的第一行都显示了其父级范围的名称。

如果要显示下面两个片段之间的行，则可以扩展上方片段的范围以显示整个文件，也可以告诉下方片段以显示其范围。

现在尝试这些方法之一。

9、1-图形教程

在Sourcetrail的默认窗口布局中，图形显示在代码旁边的左侧。 它显示项目的结构，其中所有命名符号都是节点，所有关系都是边。 像代码视图一样，它仅显示当前活动的符号以及所有传入和传出的依赖关系。

如果要查看存在哪些节点和边类型，请单击图视图右下角的“？”图标以显示图例。

10-我如何浏览图形

您可以通过在感兴趣的节点上单击鼠标左键来激活新符号。例如：查找函数“ where_am_i_drawn（）”的调用位置，移至图形并单击该函数的节点。

11-做得好

您激活了一个节点，并且图形和代码视图均已相应更新。

请注意，即使Sourcetrail提供了图形视图，它也不会消除对读取代码的需求。 图形视图非常适合快速了解关系和导航代码，但是一旦发现您感兴趣的内容，您仍然应该考虑使用代码视图实际阅读所有重要细节。

12-隐藏元素

为了不向您泛滥，图表隐藏了很多元素。 您是否看到例如“ ClassWithHiddenMembers”？ 实际上，它包含的成员比您当前看到的更多。 隐藏对当前上下文不重要的成员。 不过，您可以通过单击班级名称旁边的箭头来显示它们。 立即尝试并阅读这些成员的姓名。

Sourcetrail教程

书签管理器

使用书签管理器查看和激活您的书签。书签在其相应类别下显示为行。如果书签没有类别，它将被放置在默认类别中。仅当将鼠标悬停在相应的行上时，用于删除/编辑类别或书签的按钮才可见。书签存储在项目文件.srctrlbm旁边的单独.srctrlprj文件中。

互动方式：

通过单击名称来激活书签。

通过在书签行中单击来打开/折叠书签注释。

单击编辑按钮以更改书签的内容。

单击书签上的“删除”按钮以删除书签。

通过单击类别来打开/折叠类别。

单击类别中的“删除”按钮以删除该类别以及其中的所有书签。

更改显示过滤器以在节点和/或边的显示之间切换。

更改排序以更改书签在其类别内的顺序。

状态检视

此视图提供了不同的选项卡，其中包含有关您的项目的。默认情况下，此视图是隐藏的。

互动方式：

单击顶部的标题在选项卡之间切换。

单击x右上角的-按钮以关闭状态视图。

状态标签

下表提供了有关运行Sourcetrail时状态更新的一些。弄清为什么某些东西与预期的方式有所不同可能会有所帮助。

互动方式：

双击表格单元格以选择要复制和粘贴的文本。

使用下面的复选框按类型过滤显示的消息。

单击Clear Table以删除表中的所有行。

错误标签

此列表显示在索引编制过程中发生的错误。

提供以下：

类型：错误或致命。致命错误会导致很多丢失，因为索引器必须在此错误处停止。

错误

文件

电话号码

已编制索引：文件是否在已编制索引的文件中。

转换单位：在被索引时产生此错误的源文件。

互动方式：

单击错误行以在代码视图中查看错误的位置。

单击列标题以按此数据对错误行进行升序或降序排序。

双击表格单元格以选择要复制和粘贴的文本。

使用下面的复选框以某些条件过滤显示的错误。

单击“编辑项目”以打开“编辑项目”对话框。

工具提示

在“图形视图”和“代码视图”中显示有关悬停的符号的

提供以下：

符号类型

可见（例如公共或私人）

参考计数

符号名称

全局变量和字段的可点击类型名称。

具有函数和方法的可单击返回类型名称和参数类型名称的完整签名。

互动方式：

单击符号名称将其激活。

项目设置

Sourcetrail中的项目设置是通过“项目设置向导”完成的，可以通过在“开始”窗口中单击New Pject或通过作从“项目菜单”中进行访问New Pject。

通过项目设置向导，您可以创建一个新的Sourcetrail项目。它允许定义Sourcetrail项目的名称和位置，并添加几个Source Gups来定义将为哪些源文件建立索引。有几种创建源组的方法。对于大多数项目，仅添加一个源组就足够了。

将源组添加到项目后，此对话框可让您编辑它们的配置，以及删除或复制它们。

环境描述

Sourcetrail项目名称：项目的名称。这也将是.srctrlprjSourcetrail生成的文件的名称。

Sourcetrail项目位置：从对话框中选择项目文件的位置。

互动方式：

单击取消或按ESC将关闭窗口并中止设置过程。

单击添加源组将带您创建一个新的源组。

单击常规将带您到项目的名称和位置设置。

单击“源组”将使您可以编辑其配置并更改其名称。

单击+“源组”列表下方，将带您创建新的源组。

单击-“源组”列表下方的将删除当前选定的源组。

单击☐“源组”列表下方将复制当前选定的“源组”。

单击创建将关闭此窗口并创建新项目。

编辑项目时也使用此窗口。您可以从左侧列表中选择一个源组，编辑其内容。另外，您还可以将某些源组的活动标志设置为false，这样在刷新项目时就不会为它们建立索引。

互动方式：

更改源组的名称。

激活/停用用于索引的源组。

更改在“源组”安装过程中定义的所有设置。

选择源组类型

创建新的源组时，您可以根据项目语言在不同的设置方法之间进行选择。请查看我们的快速入门指南部分，以获取有关选择正确的源组类型的帮助。

互动方式：

选择代码项目中使用的语言。

选择源组类型将决定您如何输入所有必需的。

单击取消或按ESC将关闭窗口。

单击下一步将带您进入设置过程的下一步。

空的C / C ++源组

空的C / C ++源组具有以下配置选项：

环境描述

标准：

选择用于索引项目的语言标准。通常，此处会预先选择最新的语言标准。

交叉编译：

选中使用特定目标，使用下拉框指定特定目标平台。请查看有关交叉编译的clang编译器文档以获取更多。

文件和目录索引：

这些路径定义了Sourcetrail索引的文件和目录。提供一个目录以递归方式添加所有包含的源文件和头文件。如果项目的源代码位于一个位置，但是生成的源文件位于另一个位置，则还需要添加该目录。您可以通过$ {ENV_VAR}使用环境变量。

排除的文件和目录：

这些路径定义了将在索引编制中遗漏的文件和目录。

提示：

您可以使用*表示除或以外的字符的通配符/（例如，src/*/test.h匹配src/app/test.h但不匹配src/app/widget/test.h或src/test.h）

您可以使用**表示任意字符的通配符（例如，以及或src**test.h匹配）src/app/test.hsrc/app/widget/test.hsrc/test.h

您可以通过$ {ENV_VAR}使用环境变量

源文件扩展名：

为源文件定义有效的扩展名，包括点.cpp。Sourcetrail将仅尝试索引与这些扩展名之一匹配的文件。

包含路径：

包含路径用于解析已索引的源文件和头文件中的#include指令。这些路径通常使用’-I’或’-iquote’标志传递给编译器。在整个项目中添加所有与#include指令相关的路径。如果相对于项目的根目录指定了所有#include指令，请在此处添加该根目录。如果您的项目还包含来自外部库的文件（例如boost），请也添加这些目录（例如，添加“ path / to / boost_home / include”）。您可以通过$ {ENV_VAR}使用环境变量。

全局包含路径：

除了项目特定的“包含路径”之外，“全局包含路径”还将在您的所有项目中使用。这些路径通常使用’-isystem’标志传递给编译器。使

框架搜索路径（仅适用于macOS）：

这些路径用于查找.framework项目使用的文件

全局框架搜索路径（仅适用于macOS）：

这些框架搜索路径将在您的所有项目中使用。

编译器标志：定义在索引期间使用的其他编译器标志，包括破折号（例如，用于-DRELEASE添加#definefor RELEASE）。

预编译的头文件：

选择应用于生成预编译头文件的头文件的路径。预编译头文件将作为预索引步骤生成。如果没有提供路径，则不会生成任何预编译的头文件。

预编译的标头标志：

定义是否应将已经提供的编译器标志用于预编译头文件的生成，并定义其他标志仅用于预编译头文件的生成。