摘要：

本文主要介绍了可视化阅读代码神器Sourcetrail的安装与使用，包括软件简介和特性、下载地址、安装方式、新建工程和如何查看分析源码，同时简单介绍了PyCharm中Sourcetrail插件的使用。

文档和代码获取：

本文档主要介绍如何使用 Python 进行面向对象编程，需要读者对 Python 语法和单片机开发具有基本了解。相比其他讲解 Python 面向对象编程的博客或书籍而言，本文档更加详细、侧重于嵌入式上位机应用，以上位机和下位机的常见串口数据收发、数据处理、动态图绘制等为应用实例，同时使用 Sourcetrail代码软件对代码进行可视化阅读便于读者理解。

正文

这里，我们可以使用Sourcetrail软件对代码进行可视化阅读。Sourcetrail是一个免费开源、跨平台的可视化源码探索项目，可以使用图形直观地表示了调用上游和下游，类成员列表等等细节，使得理解源代码的结构变得很容易。下图是我们用Sourcetrail分析示例代码得到的图形化类图，可以很容易的看出SerialClass和SensorClass、MasterClass间的继承关系以及每个类的方法和属性:

我们选择Sourcetrail_2021_4_19_Windows_64bit_Installer.zip版本进行下载，下载安装包解压后，可以看到有一个msi文件，双击安装即可：

接下来我们来看如何用sourcetrail分析源代码，打开sourcetrail软件，首先点击新建工程：

接着填写项目名称和需要解析文件的地址：

接着点击添加源码组：

选择Python文件，创建空的源码分析组，点击next：

按照下图所示填写信息即可：

这里，使用虚拟环境的同学可以使用conda env list获取虚拟环境解释器位置：

配置好后点击创建：

开始创建，注意一定要勾选shallow python index选项，点击开始：

这里，可以看到我们的分析结果，Sourcetrail将解析结果按“文件”、“模块”等大致分了类，可以极大便利我们阅读他人代码的工作。点击classes：

可以看到我们文件中包含哪些类：

点击SerialClass类可以看查看属性和方法，右边有对应源码：

点击任意方法，可以看到该方法的调用情况：

项目中的符号都可以点击，支持来回跳转，还支持模糊搜索。左侧源码结构非常清晰，对于熟悉陌生代码结构非常有用。

我们也可以在Pycharm中安装插件idea-sourcetrail与其配合使用，sourcetrail支持跟你喜欢的代码编辑器链接，在编辑器中右键，就能激活sourcetrail查看上下可视化内容。当然也可以反过来，在sourcetrail中点击，直接可以在编辑器中编辑该文件。

实际上这类源码分析工具还有很多，比如Source Insight和Understand。