vim插件1--taglist

原创

昕光xg 2022-08-29 10:51:49 博主文章分类：Vim ©著作权

文章标签 vim taglist ctags php 帮助文档 文章分类 OpenStack 云计算

©著作权归作者所有：来自51CTO博客作者昕光xg的原创作品，请联系作者获取转载授权，否则将追究法律责任

vim插件1--taglist

功能

提供了源码的结构化浏览功能，可将源码中定义的函数、类、结构体、变量等以树结构显示，层次关系可一目了然，而且于快速定位并查看。

Displays the tags (functions, classes, structures, variables, etc.) defined in a file in a vertically or horizontally split Vim window.

Supports the following language files: Assembly, ASP, Awk, Beta, C, C++, C#, Cobol, Eiffel, Erlang, Fortran, HTML, Java, Javascript, Lisp, Lua, Make, Pascal, Perl, PHP, Python, Rexx, Ruby, Scheme, Shell, Slang, SML, Sql, TCL, Verilog, Vim and Yacc.

安装方法

taglist插件是以vim脚本的形式存在，因此只需要将其下载下来放到相应的目录即可。具体安装方法如下：
1)从下面网址下载taglist的安装包，并解压，得到doc/taglist.txt和plugin/taglist.vim文件；

Sourceforge https://sourceforge.net/projects/vim-taglist/files/Vim online https://vim.sourceforge.io/scripts/script.php?script_id=273

2)将脚本文件(.vim)和帮助文件(.txt)分别拷贝至vim的 plugin和doc目录

注意：

doc和plugin都在~/.vim目录下，若初次安装vim，可能没有~/.vim目录，此时需要新建该目录，并新建doc和plugin目录;

taglist的使用需要依赖ctags，但是为了实现代码补全和其它高级代码查阅功能，可考虑安装ctags（ubuntu安装方法apt-get install ctags）；

在root权限下若无法使用以上配置，则通过ll /root查看root下是否有.vim文件夹，若没有则通过ln -s /home/usrname/.vim /root/.vim 实现软链接，链接成功后可在root下使用vim的配置。笔者在debain下使用的时候发现ln后无法正常使用插件，但是直接拷贝到对应位置后可以正常使用vim插件。

使用方法

1)用vi打开某个文件后，输入:Tlist即可打开taglist，效果图如下所示；若taglist已经打开，则使用:Tlist就会关闭taglist；

vim插件1--taglist_帮助文档

2)将光标放在taglist区域，按F1就可以看到taglist的帮助信息，如下图所示：

例如：u的功能为更新taglist，当右边文档更新后(新添加了一个全局变量num)，先对文档进行保存，此时taglist并没有显示num，可将鼠标切换到taglist区域(ctrl+w可实现区域的快捷切换)，然后键盘上按u即可更新taglistl，此功能可以避免重新打开taglist；

其它功能可参考下图F1中的功能提示，也可以使用如下方式查看说明文档

:helptags ~/.vim/doc (使~/.vim/doc下的文件生效)

:help taglist (查看帮助文档)

vimrc配置taglist

以下为taglist的几个经典配置方式，可选择性使用

let Tlist_Auto_Open = 1    "启动vim后自动打开taglist窗口

let Tlist_Show_One_File = 1  "不同时显示多个文件的tag，仅显示一个

let Tlist_Exit_OnlyWindow = 1    "taglist为最后一个窗口时，退出vim

let Tlist_Use_Right_Window =1  "taglist窗口显示在右侧，缺省为左侧

"let Tlist_WinHeight = 100   "设置taglist窗口大小
let Tlist_WinWidth = 40    "设置taglist窗口大小

map <F8> :TlistToggle<CR>  "设置taglist打开关闭的快捷键F8

其它高级用法请参考帮助文档，或者官方手册

Windows 安装注意事项

Windows安装注意事项，笔者Win10安装的为vim80，安装后在VIM主目录有两个文件夹vim80、vimfiles和一个_vimrc配置文件，taglist需要依赖ctags，因此需要下载ctags，最新版本下载网址：https://sourceforge.net/projects/ctags/，下载后需要将ctags.exe拷贝到vim80文件夹下，然后在_vimrc中添加如下两行内容：