Vim+Ctags+Taglist组合：

2024-04-01 22:06:10

Ctags

1,sudo apt-get install Ctags //会提示最新版本的名字：Exuberant Ctags

2，在源码的最上层目录执行：ctags -R //会在当前目录先生成一个tags文件，这个文件中包含目录下所有.c、.h文件中的标签。它一个文本文件，你可以用vim打开它看一下。此文件缺省按区分字母大小写排序，所以直接可以被vim使用。

3，set tags=tags                //设置tags选项为当前目录下的tags文件

此时在源码文件 ctrl+]就会跳转到函数等定义处，ctrl+t返回。

Taglist(taglist依赖于ctags，所以要先装ctags)

1,下载taglist.zip并解压到 $HOME/.vim，会产生以下两个目录：

  plugin/taglist.vim - main taglist plugin file

  doc/taglist.txt    - documentation (help) file

2,使用下面的命令生成帮助标签（下面的操作在vim中进行）：

  :helptags ~/.vim/doc  生成帮助标签

  :help taglist.txt     查看taglist的帮助

3，使用:TlistToggle命令(简写:Tlist)启用这个插件,再次运行则会关闭。

4，为使用方便,在.vimrc中修改一些设置选项.

常见的设置有:

   let Tlist_Show_One_File = 1            "不同时显示多个文件的tag，只显示当前文件的

   let Tlist_Exit_OnlyWindow = 1          "如果taglist窗口是最后一个窗口，则退出vim

   let Tlist_Use_Right_Window = 1         "在右侧窗口中显示taglist窗口

   let Tlist_File_Fold_Auto_Close=1       ”自动折叠不活动的文件或buffer的标签

下面介绍常用的taglist配置选项，你可以根据自己的习惯进行配置：

- Tlist_Ctags_Cmd选项用于指定你的Exuberant ctags程序的位置，如果它没在你PATH变量所定义的路径中，需要使用此选项设置一下；

- 如果你不想同时显示多个文件中的tag，设置Tlist_Show_One_File为1。缺省为显示多个文件中的tag；

- 设置Tlist_Sort_Type为”name”可以使taglist以tag名字进行排序，缺省是按tag在文件中出现的顺序进行排序。按tag出现的范围（即所属的namespace或class）排序，已经加入taglist的TODO List，但尚未支持；

- 如果你在想taglist窗口是最后一个窗口时退出VIM，设置Tlist_Exit_OnlyWindow为１；(very useful ~~~)

- 如果你想taglist窗口出现在右侧，设置Tlist_Use_Right_Window为１。缺省显示在左侧。

- 在gvim中，如果你想显示taglist菜单，设置Tlist_Show_Menu为１。你可以使用Tlist_Max_Submenu_Items和Tlist_Max_Tag_Length来控制菜单条目数和所显示tag名字的长度；

- 缺省情况下，在双击一个tag时，才会跳到该tag定义的位置，如果你想单击tag就跳转，设置Tlist_Use_SingleClick为１；

- 如果你想在启动VIM后，自动打开taglist窗口，设置Tlist_Auto_Open为1；

- 如果你希望在选择了tag后自动关闭taglist窗口，设置Tlist_Close_On_Select为1；(这个应该比较方便,好用)

- 当同时显示多个文件中的tag时，设置Tlist_File_Fold_Auto_Close为1，可使taglist只显示当前文件tag，其它文件的tag都被折叠起来。(这个也不错! )

- 在使用:TlistToggle打开taglist窗口时，如果希望输入焦点在taglist窗口中，设置Tlist_GainFocus_On_ToggleOpen为1；(useful~~)

- 如果希望taglist始终解析文件中的tag，不管taglist窗口有没有打开，设置Tlist_Process_File_Always为1；

- Tlist_WinHeight和Tlist_WinWidth可以设置taglist窗口的高度和宽度。Tlist_Use_Horiz_Window为１设置taglist窗口横向显示；

在taglist窗口中，可以使用下面的快捷键：

<CR>          跳到光标下tag所定义的位置，用鼠标双击此tag功能也一样
o              在一个新打开的窗口中显示光标下tag
<Space>        显示光标下tag的原型定义
u              更新taglist窗口中的tag
s              更改排序方式，在按名字排序和按出现顺序排序间切换
x              taglist窗口放大和缩小，方便查看较长的tag
+              打开一个折叠，同zo
-              将tag折叠起来，同zc
*              打开所有的折叠，同zR
=              将所有tag折叠起来，同zM
[[             跳到前一个文件
]]             跳到后一个文件
q              关闭taglist窗口
<F1>           显示帮助

可以用“:TlistOpen”打开taglist窗口，用“:TlistClose”关闭taglist窗口。或者使用“:TlistToggle”在打开和关闭间切换。

在我的.vimrc中定义了下面的映射，使用“,tl”键就可以打开/关闭taglist窗口：

map <silent> <leader>tl :TlistToggle<cr>

码农公寓

相关文章