查看源代码

{{谨慎转载}}

本文介绍如何用强大的文本编辑器[[:Category:Vi/Vim编辑器 | Vim]]编程。只要配置得当，效果堪比一个IDE。

{{Hint|针对各具体语言，还有些针对性的设置方法，如[[配置基于Vim的Python编程环境]]。}}

==配置==
基本配置<ref>[http://stackoverflow.com/questions/65076/how-to-setup-vim-properly-for-editing-python-files-py How to setup VIM properly for editing Python files - *.py (StackOverflow)]</ref> <ref>[http://amix.dk/vim/vimrc.html amix的vimrc]</ref>：
<source lang="vim">
"开启语法高亮
syntax on
"依文件类型设置自动缩进
filetype indent plugin on

"显示当前的行号列号：
set ruler
"在状态栏显示正在输入的命令
set showcmd

"关闭/打开配对括号高亮
"NoMatchParen
DoMatchParen
</source>

行号的显示与隐藏<ref>[http://dancingpenguinsoflight.com/2009/02/python-and-vim-make-your-own-ide/ Python and vim: Make your own IDE (2009.2)]</ref>：
<source lang="vim">
"显示行号：
set number
"为方便复制，用<F2>开启/关闭行号显示:
nnoremap <F2> :set nonumber!<CR>:set foldcolumn=0<CR>
</source>

启用Modeline（即允许被编辑的文件以注释的形式设置Vim选项，详见[http://vim.wikia.com/wiki/Modeline_magic Vim Wiki: Modeline magic]）<ref>[http://wiki.python.org/moin/Vim Python官网上的Vim介绍]</ref>：
<source lang="vim">
set modeline
</source>

如果终端使用的是深色背景：
<source lang="vim">
"为深色背景调整配色
set background=dark
</source>

==插件管理==
下文的配置很多都依赖于第三方开发的 Vim 插件。为了方便地安装和维护这些插件，推荐先安装一种插件管理工具，目前较为流行的是 [https://github.com/gmarik/vundle/ Vundle] 和 [https://github.com/tpope/vim-pathogen/ pathogen]。二者功能类似，但 Vundle 的配置更灵活， pathogen 则相对简洁。二者都能很好地与[[wpcn:Git|Git]]结合，安装插件十分方便。

如果你使用 Git 管理你的配置文件，那么还可以将 Pathogen 或 Vundle 与 Git 的 Submodule 功能管理插件结合<ref>[http://git-scm.com/book/en/Git-Tools-Submodules Git Tools - Submodules]</ref>，使得在多台电脑间同步插件及在本地更新插件变得十分便捷。
<source lang="bash">
# 在存放配置文件的主文件夹下，添加一个 submodule
git submodule add https://github.com/gmarik/vundle.git .vim/bundle/vundle

# 用类似的办法添加多个插件后，以后升级插件只需：
git submodule update

# 如果其它电脑 checkout 出配置文件后，要先：
git submodule init
</source>

插件管理工具无需通过系统的包管理系统安装，只要将需要的文件放在 ''~/.vim/'' 目录中即可。这样，一套配置文件也可以方便地用在多个不同的系统环境中。

==代码补全==
Vim 7已经内置了代码补全功能<ref>[http://linuxtoy.org/archives/vim_7_new_features.html 细说 Vim 7 之新特性-LinuxToy]</ref>，补全操作可分为两种：
;关键字补全:即简单地补全到文档中已有的词，快捷键为 <tt>Ctrl-N</tt> 或 <tt>Ctrl-P</tt>。
;智能补全:Vim 7中引入 Omni Complete，可根据语义补全，快捷键为 <tt>Ctrl-X Ctrl-O</tt>。

Vim的补全菜单操作方式与一般IDE的方式不同，可加入如下设置<ref>[http://vim.wikia.com/wiki/VimTip1228 VimTip 1228: Improve completion popup menu]</ref>：
<source lang="vim">
"让Vim的补全菜单行为与一般IDE一致(参考VimTip1228)
set completeopt+=longest

"离开插入模式后自动关闭预览窗口
autocmd InsertLeave * if pumvisible() == 0|pclose|endif

"回车即选中当前项
inoremap <expr> <CR>       pumvisible() ? "\<C-y>" : "\<CR>"

"上下左右键的行为
inoremap <expr> <Down>     pumvisible() ? "\<C-n>" : "\<Down>"
inoremap <expr> <Up>       pumvisible() ? "\<C-p>" : "\<Up>"
inoremap <expr> <PageDown> pumvisible() ? "\<PageDown>\<C-p>\<C-n>" : "\<PageDown>"
inoremap <expr> <PageUp>   pumvisible() ? "\<PageUp>\<C-p>\<C-n>" : "\<PageUp>"
</source>

如需'''自动补全'''，可安装[http://www.vim.org/scripts/script.php?script_id=1879 AutoComplPop]插件，安装后如需在补全是显示文档（预览），可加入设置：
<source lang="vim">
let g:acp_completeoptPreview = 1
</source>

==注释管理==
经常要将一段代码注释掉或取消注释，而尤其对于某些只支持单行注释的语言来说，逐行加注释很麻烦，这时快速注释（或取消注释）代码的插件就显得很有用了。

常见的注释管理插件为[https://github.com/scrooloose/nerdcommenter The NERD Commenter]，默认支持多种语言，使用方法也很简单：只需在可视(V)模式中选择一段代码，按下<tt>\cc</tt>加逐行注释，<tt>\cu</tt>取消注释，<tt>\cm</tt>添加块注释。

如有其它需求，也可考虑[http://www.vim.org/scripts/script.php?script_id=1528 comments]、[http://www.vim.org/scripts/script.php?script_id=23 EnhCommentify]等插件。

==缩进==
使用自动缩进可能需要设置，vim中对自动缩进的详细设置办法见[[Vim代码缩进设置]]。

在不同的模式中调整缩进的方法不同：
;插入模式: <tt>Ctrl-T</tt>增加缩进，<tt>Ctrl-D</tt>减小缩进。
;命令模式: <tt> >> </tt>右缩进， <tt> << </tt>左缩进，注意<tt>n<< </tt>或 <tt>n>></tt>是缩进多行，如<tt>4>></tt>
;可视模式: <tt> < </tt>、<tt> > </tt>用于左右缩进，<tt> n< </tt>、<tt> n> </tt>可做多节缩进，如 <tt> 2> </tt>。

另外，<tt>=</tt> 可对选中的部分进行自动缩进；<tt>]p</tt>可以实现p的粘贴功能，并自动缩进。

==代码浏览与跳转==
代码跳转类似于IDE中的''Ctrl+点击''功能。与代码补全类似，代码浏览工具亦可分为基于文本分析的和基于代码理解的两类。

===简单代码跳转===
在命令模式下可直接使用下述指令：<ref>Vim文档</ref>
;跳转到定义:<tt>gd</tt>到局部变量的定义，<tt>gD</tt>到全局变量的定义
;搜索:<tt>*</tt>, <tt>#</tt> 可对光标处的词向前/向后做全词搜索，<tt>g*</tt>, <tt>g#</tt> 做相对应的非全词匹配搜索
;代码块首尾:<tt>[[</tt>, <tt>]]</tt> 可跳到当前代码块起始或结束的大括号处。
;括号首尾:<tt>%</tt> 可在配对的括号、块首尾之前跳转。
;位置历史:<tt>Ctrl-O</tt> 在历史记录中后台，<tt>Ctrl-I</tt> 则为前进。

===基于代码理解的跳转===
该功能依赖于ctags工具。<ref>[http://vim.wikia.com/wiki/Browsing_programs_with_tags Browsing programs with tags -- Vim Tips Wiki]</ref>安装好ctags后，在存放代码的文件夹运行
 ctags -R .
即可生成一个描述代码结构的tags文件。

{{Hint|ctags的功能很强大，更详细的配置请参考其文档。}}

建议在''~/.vimrc''中添加如下配置以使Vim在父目录中寻找tags文件<ref>[http://stackoverflow.com/questions/563616/vim-and-ctags-tips-and-tricks Vim and Ctags tips and tricks]</ref>：
<source lang="vim">
set tags=tags;/
</source>

设置好后，可在Vim中使用如下功能：<tt>Ctrl-]</tt>转至最佳匹配的相应Tag，<tt>Ctrl-T</tt>返回上一个匹配。如果有多个匹配，<tt>g Ctrl-]</tt>可显示所有备选的tags。如有需要，可互换<tt>Ctrl-]</tt>和<tt>g Ctrl-]</tt> <ref>[http://stackoverflow.com/questions/7640663/use-tjump-instead-of-tag-vim-on-pressing-ctrl use :tjump instead of :tag vim on pressing ctrl-&#93; (StackOverflow)]</ref>：
<source lang="vim">
"在普通和可视模式中，将<c-]>与g<c-]>互换
nnoremap <c-]> g<c-]>
vnoremap <c-]> g<c-]>

nnoremap g<c-]> <c-]>
vnoremap g<c-]> <c-]>
</source>

==就地编译和错误处理==
使用<tt>:make</tt>可调用make命令编译程序，配合Vim内置的QuickFix功能，可以像IDE一样打开一个窗口展示编译错误和警告，通过它还可以方便地跳转到各编译错误的产生位置。

常用的命令有<tt>:cw[indow]</tt>（如有错误打开quickfix窗口）、<tt>:cn</tt>（跳到下一个错误）、<tt>:cp</tt>（跳到前一个错误）等，具体可<tt>:help quickfix</tt>。

如果想在有错时自动打开quickfix窗口<ref>[http://vim.wikia.com/wiki/Automatically_open_the_quickfix_window_on_:make Automatically open the quickfix window on :make]</ref>：
<source lang="vim">
" 编译后，如有错误则打开quickfix窗口。（光标仍停留在源码窗口）
"
" 注意：需要开启netsting autocmd
autocmd QuickFixCmdPost [^l]* nested cwindow
autocmd QuickFixCmdPost    l* nested lwindow
</source>

默认情况下，<tt>:mak[e]</tt>会跳转到第一个错误，如果不想启用这个功能，请使用<tt>:make!</tt>。

==代码折叠==
代码较长时可启用代码折叠功能，如按语法高亮元素折叠：
<source lang="vim">
set foldmethod=syntax
"默认情况下不折叠
set foldlevel=99
</source>
随后即可使用z系列命令管理代码折叠。如<tt>za</tt>会翻转当前位置的折叠状态，<tt>zA</tt>会递归翻转当前层所有代码的折叠状态等。当然也可以把功能键映射到za:
<source lang="vim">
map <F3> za
</source>

==查看文档==
<tt>K</tt> 键可用于查看当前函数的文档。

==其它插件==
近来仍被积极维护的代码托管在 GitHub 上的插件<ref>[https://github.com/xuxiaodong/vimenv LinuxTOY Xu Xiaodong 的VimEnv]</ref>：
;[https://github.com/tpope/vim-fugitive/ Fugitive]:让 Vim 更好地与 [[wpcn:Git|Git]] 整合。
;[https://github.com/Lokaltog/vim-powerline Powerline]:炫丽实用的状态栏
;[http://majutsushi.github.com/tagbar/ Tagbar]: 比 [http://www.vim.org/scripts/script.php?script_id=273 taglist] 更现代的代码结构浏览工具
;[https://github.com/scrooloose/nerdtree The NERD tree]:以树形结构浏览文件夹中的文件
;[https://github.com/scrooloose/syntastic Syntastic]:语法检查
;[https://github.com/tpope/vim-surround surround.vim]:快速删除/修改光标周围配对的括号

其它常用插件<ref>[http://blog.csdn.net/wooin/article/details/1858917 手把手教你把Vim改装成一个IDE编程环境(图文)] </ref>：
;[http://www.vim.org/scripts/script.php?script_id=69 Project]:方便管理工程中的文件
;[http://www.vim.org/scripts/script.php?script_id=2540 snipmate.vim]:在编辑中实现模板展开
;[http://www.vim.org/scripts/script.php?script_id=31 a.vim]:在''.cpp/.h''等文件对中跳转
;[http://www.vim.org/scripts/script.php?script_id=39 matchit.zip]:增强<tt>%</tt>的功能
;[http://www.vim.org/scripts/script.php?script_id=95 winmanager]:将文件管理窗口和taglist堆叠起来。

== 相关文档 ==
*[[配置基于Vim的Python编程环境]]
*[[让vim自动判断中文编码]]

==参考资料==
<references />

[[Category: Vi/Vim编辑器]]