Sourcetrail官方版

Sourcetrail简介

Sourcetrail提供源代码管理的功能。您可以在软件中创建源代码项目，并且可以设置项目索引。方便以后查询这个软件的源代码。源代码内容可以复制和使用。个人和企业都可以通过这个软件构建源代码库。您可以在软件中创建c++项目、C语言项目、Java项目和Python项目。以类似思维导图的方式可视化您的代码项目。所有代码项目都可以被索引。单击相关的源代码组展开项目以查看源代码。建立索引后，您可以在图形界面中查看索引符号，并且可以轻松访问搜索栏中的所有索引符号。用它找到所有你想学习的类和函数！

Sourcetrail软件功能

1索引你的源代码。

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

2找到任何符号。

使用Sourcetrail的搜索栏快速查找整个代码库中的任何符号。模糊代码搜索引擎可以为您提供最佳匹配只需几个按键。

3可视化探索依赖性

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

浏览您的源代码

最后，代码视图将焦点元素的所有实现细节保存在一个整洁的代码片段列表中。扩大范围并突出显示局部变量，或者注意遇到的任何其他引用或元素。

5连接到源代码编辑器。

通过插件将Sourcetrail与您最喜欢的源代码编辑器同步。这使得在写作和探索之间切换变得很容易。

Sourcetrail软件特色

Sourcetrail是:

自由

脱机工作

在Windows、macOS和Linux上运行

支持C、C ++、Java和Python

提供一个SDK(SourcetrailDB)来编写自定义语言扩展。

可连接的编辑器:

Atom、Clion、Eclipse、Emacs、IntelliJ IDEA、Neovim、PyCharm、QtCreator、崇高文本、vim、Visual Studio、Visual Studio Code

Sourcetrail使用说明

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

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

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

3.你想过生命、宇宙和一切的意义吗？单击相应的符号找到它。点按“代码视图”右上角的“剪辑列表模式”按钮。

4.这是Sourcetrail教程的中心。在这里，你可以进行一次短途旅行，探索Sourcetrail的不同地方。最重要的是，您将了解Sourcetrail的所有不同部分是如何相互作用的。

以下功能参考了所有可用的教程。因此，选择一个并立即采取行动。

5.我们刚刚讨论了Sourcetrail，它为重要的代码行提供了上下文。

但感觉这里好像少了点什么。什么是“问题”？它是从哪里来的？

3-扩大范围

你看到这段代码的第一行了吗？我的意思是，只有两个点作为行号，它们显示为“deep _ think”。事实上，这是封装代码片段的函数作用域的名称。通过单击该行，您可以告诉Sourcetrail展开视图以显示整个范围。

6.不再有内容。

在这个阶段，您将看到整个文件，并且不能扩展其他上下文。

在这个介绍的最后，请看看“无关_但是_非常重要()”函数的用法。

7、6-片段和文件

这个函数似乎是在同一个文件的两个不同地方调用的。当两个不同的剪辑在同一个文件中时，它们共享一个文件盒。左边的行号表示文件中每个代码片段的位置。

8-合并剪辑

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

如果您想要显示接下来两个剪辑之间的线条，您可以扩大上剪辑的范围以显示整个文件，或者您可以告诉下剪辑显示其范围。

现在尝试其中一种方法。

9，1-图形教程

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

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

10-如何浏览图形？

您可以通过在感兴趣的节点上单击鼠标左键来激活新符号。例如，找到函数“where _ am _ I _ draw()”的调用位置，将其移动到图中并单击该函数的节点。

1-做得好

您已经激活了一个节点，图形和代码视图也相应地更新了。

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

12-隐藏元素

为了不淹没你，图表隐藏了很多元素。你见过“有身份的人”这种东西吗？事实上，它包含的成员比您当前看到的要多。隐藏对当前上下文不重要的成员。但是，您可以通过单击类名旁边的箭头来显示它们。试着立即阅读这些成员的名字。

Sourcetrail教程

书签管理器

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

交互模式:

通过单击名称激活书签。

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

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

单击书签上的删除按钮删除书签。

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

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

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

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

状态视图

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

交互模式:

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

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

状态标签

下表提供了有关运行Sourcetrail时状态更新的一些信息。找出事情与预期方式不同的原因可能会有所帮助。

交互模式:

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

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

单击“清除表格”删除表格中的所有行。

错误标签

此列表显示了索引过程中出现的错误。

提供以下信息:

类型:错误或致命。致命错误会导致许多损失，因为索引器必须停止在这个错误。

错误

文件

电话号码

索引:文件是否在索引文件中。

转换单位:索引时导致此错误的源文件。

交互模式:

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

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

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

使用下面的复选框按特定条件过滤显示的错误。

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

工具提示

在图形视图和代码视图中显示关于悬停符号。

提供以下信息:

符号类型

可见(例如公共或私有)

参考计数

符号名称

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

可通过函数和方法单击返回类型名和参数类型名的完整签名。

交互模式:

单击符号名称将其激活。

项目设置

Sourcetrail中的项目设置是通过项目设置向导完成的，可以通过单击“开始”窗口中的“新建项目”或通过从“项目”菜单访问该向导。

您可以通过项目设置向导创建新的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指令。这些路径通常使用& # 8217；-我& # 8217；或者& # 8217；-iquite & # 8217；标志被传递给编译器。在整个项目中添加与#include指令相关的所有路径。如果所有#include指令都是相对于项目根目录指定的，请在此添加根目录。如果您的项目还包含来自外部库(如boost)的文件，请也添加这些目录(如“路径/到/boost_home/include”)。您可以通过$ {ENV_VAR}使用环境变量。

全局包含路径:

除了项目特定的“包含路径”之外，“全局包含路径”将用于您的所有项目。这些路径通常使用& # 8217；-is system & # 8217；标志被传递给编译器。制造

框架搜索路径(仅适用于macOS):

这些路径用于查找使用的文件。框架项目。

全球框架搜索路径(仅限macOS):

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

编译器标志:定义在索引过程中使用的其他编译器标志，包括破折号(例如，#definefor RELEASE for -DRELEASE)。

预编译头文件:

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

预编译头标志:

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