收费工具Source Insight、Understand
Sourcetrail开源工具
一、下载安装
接下来就是download,在GitHub的release页面选择自己系统对应的发布版本下载安装:
安装好后,运行程序,会出现这样的界面:
二、应用
选择“New Project”,在随后的界面中填写好项目名称和项目路径:
填好后点击下方的Add Source Group按钮,用以添加代码。
——在Sourcetrail中允许我们在同一个项目中添加多个来源的代码,甚至允许各个代码分组的语言互不相同,这些代码分组即为各个Source Group
只需要查看一个代码库的内容,因此我们也只需要添加一个Source Group即可,如下图依次点击:
在继续输入新的信息前,打开你的命令行工具(Windows系统:Win+R,输入cmd然后回车;Linux下不赘述),输入where python(Windows)或which python3(Linux),即可看到当前环境的Python安装路径,记下这个路径,我们需要用它来解析Python代码。
然后在新的界面中,需要填写Python环境的字段填入刚刚我们查到的Python所在目录(即去除最后一个斜杠及之后的内容)。
其他的需要注意的就是“要建立索引的文件/目录”,这个字段就是添加我们真正要阅读的Python源码路径。字段左下角有一个“+”号,点击即可增加一个源码路径:
点击右下角“Create”,再点击“Start”:
结果解析:
可以看到,Sourcetrail将解析结果按“文件”、“模块”等大致分了类。
我们点击最关心的“函数(Function)”来体验一下:
在左边,Sourcetrail为我们生成了形象的调用图;在右边,Sourcetrail列出了当前焦点函数的代码及其相应调用。
无论在左边操作还是在右边操作,都会带来界面的同步变化。