不依赖代码阅读软件,直接通过vim进行代码阅读,通过配置以下工具,使其函数定义引用能够自由跳转,以下是ctags,Nerdtree,Taglist的安装配置以及使用命令。
1. ctags
介绍 :ctags是一个常用的代码阅读工具,它可以生成用于代码导航的标签文件。下面是一些常用的ctags命令:
-
生成标签文件:
ctags [选项] [文件或目录]
- 示例:
ctags -R src/
生成当前目录下src目录及其子目录中的所有源代码文件的标签文件。
- 示例:
-
在Vim中跳转至定义处:在Vim编辑器中,使用
Ctrl+]
命令可以跳转至光标所在的标识符的定义处,如果有多个定义,则会列出供选择。- 示例:在Vim中打开源代码文件,将光标移动至某个函数名上,然后按下
Ctrl+]
即可跳转至定义处。
在Vim中跳转至定义处后,可以使用以下命令退回到之前的位置:- 退回到上一个位置:按下
Ctrl+t
,或者在命令模式下输入:pop
,即可退回到上个标签位置。 - 退回到跳转前的位置:按下
Ctrl+o
,或者在命令模式下输入:normal! g;
,即可退回到跳转前的位置。 - 查找函数名
:ts function_name
,上一个:tp
下一个:tn
。
- 退回到上一个位置:按下
- 示例:在Vim中打开源代码文件,将光标移动至某个函数名上,然后按下
-
列出函数、变量等定义:使用
ctags -x
命令可以列出标签文件中的函数、变量等定义列表。- 示例:
ctags -x --c-kinds=+p src/main.c
列出main.c文件中的所有函数定义。
- 示例:
-
查找标识符定义:使用
ctags -R --fields=+i -e [标识符]
命令可以查找标识符的定义位置。- 示例:
ctags -R --fields=+i -e MyFunction
查找标签文件中名为MyFunction的函数定义。
- 示例:
-
列出调用某个函数的地方:使用
ctags -R --fields=+i -x --c-kinds=f [函数名]
命令可以列出调用某个函数的地方。- 示例:
ctags -R --fields=+i -x --c-kinds=f MyFunction
列出调用MyFunction函数的位置。
- 示例:
2. Nerdtree
Nerdtree是一个在 Vim 编辑器中用于浏览文件目录的插件。它提供了一个侧边栏的树形结构,可让你快速导航和管理项目文件。
-
安装 Nerdtree:
- 使用插件管理器(如 Vundle、Pathogen 或 Vim-Plug)进行安装。例如,如果使用 Vim-Plug,可以将
Plug 'preservim/nerdtree'
添加到.vimrc
文件,并运行:PlugInstall
安装插件。 - 如果你没有使用插件管理器,也可以手动下载插件源码,将其解压并将其放置在 Vim 的插件目录下。
- 使用插件管理器(如 Vundle、Pathogen 或 Vim-Plug)进行安装。例如,如果使用 Vim-Plug,可以将
-
启动 Nerdtree:
- 在 Vim 中键入
:NERDTree
命令,或者将NERDTreeToggle
命令映射到一个快捷键(如<F2>
),方便快速启动和关闭。
- 在 Vim 中键入
-
使用 Nerdtree:
- 打开 Nerdtree 侧边栏:启动 Nerdtree 后,会在 Vim 窗口的侧边显示文件目录的树形结构。该窗格中的文件和文件夹组织成层次结构。
- 导航和展开目录:使用
<CR>
键或o
键来打开选中的文件或目录。使用<Enter>
键或i
键来进入选中的目录并展开其子目录。 - 关闭文件或目录:
- 使用
q
键关闭当前打开的文件或目录。 - 使用
Ctrl + w
或Ctrl + ww
在 Nerdtree 窗格和编辑窗格之间进行切换。
- 使用
- 其他操作:
- 使用
p
键来跳转到上级目录。 - 使用
P
键来跳转到根目录。 - 使用
m
键来显示 Nerdtree 的操作菜单。 - 使用
?
键来查看 Nerdtree 的快捷键帮助。
- 使用
使用 Nerdtree,你可以轻松地在 Vim 中浏览和管理文件目录,方便地进行文件切换、查找和操作。它是一个强大而实用的插件,为 Vim 用户提供了更好的文件导航体验。
3. Taglist
Taglist 是一个在 Vim 编辑器中用于显示代码标签(tags)的插件。它可以根据代码中的函数、类、变量等定义生成一个侧边栏,方便用户快速浏览和导航代码。
-
安装 Taglist:
- 使用插件管理器(如 Vundle、Pathogen 或 Vim-Plug)进行安装。例如,如果使用 Vim-Plug,可以将Plug 'vim-scripts/taglist.vim'
添加到.vimrc
文件,并运行:PlugInstall
安装插件。
- 如果你没有使用插件管理器,也可以手动下载插件源码,将其解压并将其放置在 Vim 的插件目录下。 -
启动 Taglist:
- 在 Vim 中键入:TlistToggle
命令,或者将TlistToggle
命令映射到一个快捷键(如<F3>
),方便快速启动和关闭。 -
使用 Taglist:
- 打开 Taglist 侧边栏:启动 Taglist 后,会在 Vim 窗口的侧边显示代码标签的列表。该列表按照代码结构组织,可包含函数、类、变量等定义。
- 导航到标签:使用光标键(如上、下、回车)在标签列表中导航并选择要查看的标签。
- 查看标签详细信息:选中一个标签后,可以按下o
键或<Enter>
键来查看标签的详细信息和位置。
- 关闭 Taglist 侧边栏:按下q
键可关闭 Taglist 侧边栏。
除了上述命令外,Taglist 还提供了其他许多功能和快捷键,例如:
- <Space>
键:在标签列表和编辑窗格之间切换焦点。
- s
键:在垂直分割窗格中显示选定标签。
- Ctrl + ]
:跳转到标签定义处。
- Ctrl + t
:返回上一个位置。
Taglist 提供了一个方便的方式来浏览和导航代码,特别是对于大型项目或复杂的代码库来说。它使得在 Vim 中跳转到不同的函数、类和变量定义变得更加容易和高效。