阅读源码的工具不少,今天给你们推荐一款别具一格的源码阅读神器。git
它就是 Sourcetrail,一个免费开源、跨平台的可视化源码探索项目。github
直接看效果图:微信
上面是我阅读 okhttp 源码的一个界面,不一样于其余代码编辑器的导航栏,左侧使用图形直观地表示了调用上游和下游,类成员列表等等细节,使得理解源代码的结构变得很容易。app
目前支持 C、C++、Python 和 Java 语言,同时提供了相关 SDK 用于拓展支持其它语言,相信在将来会提供更多语言的支持。编辑器
官网地址:工具
https://www.sourcetrail.com/spa
目前已经开源:.net
https://github.com/CoatiSoftware/Sourcetrail3d
支持 Windows、macOS、Linux 三个平台,下载地址:code
https://github.com/CoatiSoftware/Sourcetrail/releases
下面简单介绍下如何使用 sourcetrail 阅读源码,以 okhttp 源码为例:
首先打开界面以下,点击左侧的 New Project
建立项目
选择预先下载好的 okhttp 源码文件夹
点击 Add Source Group
,选择 Empty Java Source Group:
点击 Next
到下面这个界面, 依次点击步骤 一、2 指定索引文件:
点击 Next
后出现下面的界面,点击 Create
按钮:
选择 All Files
, 点击 Start
按钮开始索引,等待一段时间。
出现 Error 是正常的,由于源码中有不少文件找不到,不影响阅读源码。
索引完成后点击 OK
,就能够开始源码阅读了。
项目中的符号均可以点击,支持来回跳转,还支持模糊搜索。左侧源码结构很是清晰,对于熟悉陌生代码结构很是有用。
还能够与其余编辑器连接,好比:Atom, Clion, Eclipse, Emacs, IntelliJ IDEA 等等。
还有更多功能能够参见官方文档:
https://www.sourcetrail.com/documentation/
通常不特意推荐,一推荐必是利器。赶忙上手体验下。
本文分享自微信公众号 - 贾小昆(zywudev)。
若有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一块儿分享。