一、新建项目
与其他代码编辑工具不同,Source Insight 作为一款以代码浏览为主的工具,主要用于阅读和分析代码。因此,建议将每一个代码工程单独建立为一个工作项目(Project)。
要新建项目,可以点击菜单栏中的 Project > New Project,开始创建一个新的项目。
项目数据文件与源代码文件的区别:
项目数据文件与项目的源代码文件是不同的。在此步骤中,保存的是项目的数据文件,而非源代码文件。源代码将在后续步骤中导入。
二、找到源码文件位置
导入源代码:
在此步骤中,Source Insight 将导入该项目的源代码文件。
项目备份位置:
为了避免源代码被意外删除,软件会默认设置一个项目备份位置。通常情况下,保持默认设置即可,无需更改。
重点设置项:
这一阶段只有一个关键项需要手动设置——指定源代码所在的位置。此操作的作用是告诉 Source Insight 项目源代码的大致目录路径。需要注意的是,这一步仅用于“定位”源代码文件夹,尚未真正将文件添加到项目中。
关于几种添加文件的方式:
在添加源代码文件时,Source Insight 提供了几种不同的添加方式,功能如下:
项目数据文件与项目的源代码文件是不同的。在此步骤中,保存的是项目的数据文件,而非源代码文件。源代码将在后续步骤中导入。
二、找到源码文件位置
导入源代码:在此步骤中,Source Insight 将导入该项目的源代码文件。
项目备份位置:
为了避免源代码被意外删除,软件会默认设置一个项目备份位置。通常情况下,保持默认设置即可,无需更改。
重点设置项:
这一阶段只有一个关键项需要手动设置——指定源代码所在的位置。此操作的作用是告诉 Source Insight 项目源代码的大致目录路径。需要注意的是,这一步仅用于“定位”源代码文件夹,尚未真正将文件添加到项目中。
三、添加和筛选具体的文件
添加文件到项目中:
本步骤用于筛选并将实际需要的文件或文件夹添加到项目中。只有被添加到项目文件列表中的文件,才会被 Source Insight 进行语法解析和建立索引。
众所周知,许多项目除了源代码文件外,还包含一些无用的文件,例如图片、临时文件或配置备份等。此时,用户可以根据需要选择性地添加源代码文件,也可以将所有文件一并添加,尽管其中可能包含一些无关内容。
如果希望一次性导入所有文件(包括子文件夹及其下的所有内容),可以点击 Add Tree 按钮。完成文件添加后,点击 Close 即可完成项目的创建与初始化。
本步骤用于筛选并将实际需要的文件或文件夹添加到项目中。只有被添加到项目文件列表中的文件,才会被 Source Insight 进行语法解析和建立索引。
众所周知,许多项目除了源代码文件外,还包含一些无用的文件,例如图片、临时文件或配置备份等。此时,用户可以根据需要选择性地添加源代码文件,也可以将所有文件一并添加,尽管其中可能包含一些无关内容。
如果希望一次性导入所有文件(包括子文件夹及其下的所有内容),可以点击 Add Tree 按钮。完成文件添加后,点击 Close 即可完成项目的创建与初始化。
关于几种添加文件的方式:
在添加源代码文件时,Source Insight 提供了几种不同的添加方式,功能如下:
- Add:手动选择并导入单个文件。适用于只需添加少量文件的情况。
- Add All:导入当前所选文件夹下的所有文件,但不包括子文件夹中的文件。
- Add Tree:递归导入当前所选文件夹及其所有子文件夹中的文件。这是最常用且高效的方式,适合将整个代码库一次性导入项目中。
四、告知insight 分析项目
点击菜单栏中的 Project > Rebuild Project 即可开始项目的构建操作。如果用户对源代码进行了修改,建议执行一次项目重建,以便通知 Source Insight 项目的符号和函数关系已发生变化。只有通过重建,Source Insight 才能正确识别函数声明与实际源代码之间的对应关系。
五、阅读项目代码
查找项目中的文件:
在项目窗口中,可以通过浏览项目结构或文件夹列表来查找你需要阅读的源代码文件。例如,可以按照文件夹层级查找,也可以在 Project Files 中快速定位指定类别的文件。
关于阅读方式与快捷键:
对于初学者来说,无需记忆繁多的快捷键。只要熟悉如何通过项目窗口或文件列表定位并打开文件,就足以完成大多数的代码阅读工作。
在项目窗口中,可以通过浏览项目结构或文件夹列表来查找你需要阅读的源代码文件。例如,可以按照文件夹层级查找,也可以在 Project Files 中快速定位指定类别的文件。
关于阅读方式与快捷键:
对于初学者来说,无需记忆繁多的快捷键。只要熟悉如何通过项目窗口或文件列表定位并打开文件,就足以完成大多数的代码阅读工作。