代码阅读利器：Source Insight 基本操作

一、Source Insight

1. Source Insight

为什么要使用 Source Insight

• 在做项目过程中，我们要阅读的代码非常复杂，工程中包含了非常多的API接口和自定义结构体、函数等。为了尽快熟悉整个项目的流程，必须借助一定的工具来提高我们代码阅读的效率。
• Source Insight可以帮助我们快速查询某个变量或函数的定义、调用关系，以及全局查找功能，从而使我们在代码阅读和调试过程中提高效率。

2. 新建工程

通常地，对于一个工程，可建立如下的目录结构：

--Led_project   // 项目工程
--si            // Source Insight工程
--log           // 调试日志文件
--output        // 其他输出文件，如自定义的总结文件

(1) Project -> New Project

输入工程名称和存放路径，这里存放在新建的 si 文件夹内

点击 OK 进入 New Project Setting

(2) 点击 Browse 配置项目工程路径

注意是与 si 文件夹同一级的目录，包含所有工程文件

点击 OK 进入工程文件添加与删除对话框

(3) Add Tree 添加所有文件

在添加工程文件时，有三个选项，最常用的是 Add Tree

第一种方式：
通过在File Name中输入要阅读源代码文件的名称，点击“Add”按钮将其加入；
第二种方式：
通过其中“Add All”和“Add Tree”两个按钮可以将选中目录的所有文件加入到工程中，其中“Add All”选项会提示加入顶层文件和递归加入所有文件两种方式，而“Add Tree”相当于“Add All”选项的递归加入所有文件，可以根据需要使用；
第三种方式（比较常用）：
“Add Tree”一些。由于该程序采用了部分打开文件的方式，没有用到的文件不会打开，所以，加入数千个文件也不用担心加入的文件超出程序的所能容忍的最大值；

添加后 点击 Close 关闭对话框

(4) Project->Synchronize Files

同步文件，生成索引

现在就可以阅读代码了

3. 界面介绍

（1）A区：该文件中的头文件、变量、函数等，可在上方搜索栏搜索相关函数等内容；
（2）B区：工程中的所有文件，可在上方搜索栏搜索相关文件名；
（3）C区：变量函数定义区，显示光标指示变量或函数的定义内容，双击C区可进入定义文件中
（4）D区：调用关系显示区，显示光标指示变量或函数调用的函数或被哪些函数调用，双击被调用的函数名可进入该函数中

4.全局搜索

在熟悉工程代码和调试时，用得最多的是C区和D区，以及全局搜索功能。
（1）全局搜索
使用全局搜索有两种方式

• Ctrl + /
• 菜单栏 R 标标志

使用较多的是菜单栏中的全局搜索标志，操作流程如下：

1. 双击函数名选中，点击 R 标志。弹出下图对话框，点击 Search
   
2. 显示方式选择，前两项都可以，这里使用 Replace
   
   3.点击最前面的红色双向箭头，可进入到它在文件中的位置
   
   同时，使用菜单栏上的跳转工具（前两个），可在查找结果见跳转
   
   以上便实现了变量函数等内容的查询。

此外， Ctrl + F 这一通用查询快捷键在 Source Insight 中也能使用

Ctrl + F 在 PDF/txt/Sublime 等文本编辑器中均能使用

本篇博客介绍了 Source Insight 的基本使用，其他功能和更详细的介绍可参考
这里。

二、其他工具

1.SecureCRT 与 Xcom

这两个工具是串口调试工具，在调试 UART 时经常使用
相比之下，Xcom 保存打印日志更加方便。

2. Sublime

Sublime的界面风格非常炫酷，不仅可以查看文件，还可以查看整个工程代码，只需将整个工程拖拽到左侧的文件窗口。

3. Bcompare

对比软件，顾名思义，可对比查看两个文件的不同之处，查看文件修改情况。但Bcompare不仅限于文本对比，还可用于整个工程的对比。

4. Git

本地仓库，记录和查看工程修改内容。

5. datasheet

datasheet查询客户端，便于查询芯片的数据手册。