Sourcetrail - 免费开源的跨平台源代码探索工具

本文翻译整理自：https://github.com/CoatiSoftware/Sourcetrail

文章目录

• • 一、关于 Sourcetrail
  • • 相关链接资源
    • 关键功能特性
  • 二、安装使用
  • 三、问题反馈
  • • 1、问题报告
    • 2、支持请求
  • 四、贡献指南
  • 五、构建指南
  • • 1、基础应用构建
    • • 必备工具
      • 必备依赖
      • 构建步骤
      • • Windows平台
        • Unix平台
    • 2、语言支持扩展
    • • C/C++支持
      • Java支持
      • Python支持
    • 3、部署包制作
    • • Windows平台
      • macOS平台
      • Linux平台
  • 六、测试运行
  • 七、许可信息

一、关于 Sourcetrail

重要提示： 本项目已于2021年底由Sourcetrail的原作者和维护者归档。如需了解此决策详情，请阅读我们的博客文章。

Sourcetrail 是一款免费开源的跨平台源代码探索工具，可帮助您快速理解陌生代码库。

Windows构建状态：https://ci.appveyor.com/project/mlangkabel/sourcetrail/branch/master
Linux构建状态：https://travis-ci.org/CoatiSoftware/Sourcetrail

相关链接资源

• github : https://github.com/CoatiSoftware/Sourcetrail
• 下载地址：https://github.com/CoatiSoftware/Sourcetrail/releases
• 快速入门指南：
• 完整文档：
• 更新日志：
• 官方博客：https://www.sourcetrail.com/blog/
• License : GNU General Public License Version 3

关键功能特性

Sourcetrail具备以下特点：

• 完全免费
• 支持离线工作
• 跨平台支持Windows、macOS和Linux
• 支持C、C++、Java和Python语言
• 提供SDK（SourcetrailDB）用于编写自定义语言扩展

二、安装使用

可通过以下方式安装Sourcetrail：
1、从发布页面下载对应操作系统的安装包
2、使用包管理器安装：
通过Chocolatey安装：

choco install sourcetrail

安装完成后，请参考快速入门指南开始使用。

三、问题反馈

1、问题报告

所有功能请求和错误报告均可提交至我们的问题追踪系统。

请使用以下模板：

• 操作系统版本：
• Sourcetrail版本：
• 问题描述：
• 重现步骤：

2、支持请求

若您支持某个功能请求或遇到他人已报告的错误：

• 在对应issue下评论\"+1\"
• 或发送邮件至support@sourcetrail.com（注明issue ID）

四、贡献指南

1、请先阅读并遵循CONTRIBUTING.md中的步骤
2、可优先处理标记为good first issue的任务
3、更多开发信息请参考项目Wiki

五、构建指南

构建Sourcetrail需要满足多项依赖，但通过CMake可选择性禁用特定语言支持以减少依赖项。

1、基础应用构建

必备工具

• CMake v3.12
  下载：https://cmake.org/download
• Git
  下载：https://git-scm.com/download
  注意：需确保git已加入PATH环境变量
• Visual Studio（仅Windows）
  下载：https://visualstudio.microsoft.com/downloads/
• ccache（Linux/macOS可选）
  下载：https://ccache.dev/download.html

必备依赖

• Boost 1.67
  下载（Windows预编译版）：https://sourceforge.net/projects/boost/files/boost-binaries/
  编译命令（Unix）：

$ ./bootstrap.sh --with-libraries=filesystem,program_options,system,date_time$ ./b2 --link=static --variant=release --threading=multi --runtime-link=static --cxxflags=-fPIC

• Qt 5.12.3
  下载：http://download.qt.io/official_releases/qt/

构建步骤

Windows平台

$ git clone https://github.com/CoatiSoftware/Sourcetrail.git$ cd Sourcetrail$ mkdir -p build/win64$ cd build/win64$ cmake -G \"Visual Studio 15 2017 Win64\" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..

Unix平台

$ cd Sourcetrail$ mkdir -p build/Release$ cd build/Release$ cmake -DCMAKE_BUILD_TYPE=\"Release\" -DBOOST_ROOT=<path/to/boost_1_67_0> -DQt5_DIR=<path/to/Qt/version/platform/compiler/lib/cmake/Qt5> ../..$ make Sourcetrail

2、语言支持扩展

C/C++支持

• 依赖：LLVM/Clang 11.0.0
  构建指南：https://clang.llvm.org/get_started.html
• 构建参数：

-DClang_DIR=<path/to/llvm_build>/lib/cmake/clang-DBUILD_CXX_LANGUAGE_PACKAGE=ON

Java支持

• 依赖：JDK 1.8 + Maven
  需设置环境变量：

JAVA_HOME=<path/to/Java>/jdk1.x.x_xxxM2_HOME=.../apache-maven-x.x.xMAVEN_HOME=.../apache-maven-x.x.x

• 构建参数：

-DBUILD_JAVA_LANGUAGE_PACKAGE=ON

Python支持

• Windows需安装7z
• 构建参数：

-DBUILD_PYTHON_LANGUAGE_PACKAGE=ON

3、部署包制作

Windows平台

• 需安装：
  • Visual Studio（含.NET桌面开发组件）
  • Wix 3.11工具集
  • WinRAR
• 执行部署脚本：

./script/deploy_windows.sh

macOS平台

执行bundle_install.sh生成.dmg安装包

Linux平台

执行./setup/Linux/createPackages.sh生成.tar.gz和.AppImage包

六、测试运行

测试套件基于Catch2框架，执行前请确保工作目录设置为./bin/test。

七、许可信息

Sourcetrail采用GNU通用公共许可证第3版授权。\"Sourcetrail\"名称是Coati Software的商标，不包含在GPLv3许可范围内。

伊织 xAI 2025-04-23（三）