*For simplicity, let's use [VIM_ROOT] which will mean ~/.vim (*nix) or ~/vimfiles (Windows)
The NERD Commenter requires Vim 7 or higher is comprised of 2 files:
plugin/NERD_commenter.vim
doc/NERD_commenter.txt
- Extract the plugin files into your [VIM_ROOT]/plugin and [VIM_ROOT]/doc folders respectively.
- Finish the install by updating your help files. Run:
:helptags [VIM_ROOT]/docSee |add-local-help| for more details.
- Navigate to your [VIM_ROOT]/bundle directory in your local Vim setup
- git clone https://github.com/scrooloose/nerdcommenter.git
After the 'Classic' or 'Pathogen' install, make sure that you have filetype plugins enabled, as the script makes use of |'commentstring'| where possible (which is usually set in a filetype plugin). See |filetype-plugin-on| for details, but basically, stick this in your vimrc:
filetype plugin on
The following key mappings are provided by default (there is also a menu provided that contains menu items corresponding to all the below mappings):
Most of the following mappings are for normal/visual mode only. The |NERDComInsertComment| mapping is for insert mode only.
[count]<leader>cc |NERDComComment| Comment out the current line or text selected in visual mode.
[count]<leader>cn |NERDComNestedComment| Same as <leader>cc but forces nesting.
[count]<leader>c<space> |NERDComToggleComment| Toggles the comment state of the selected line(s). If the topmost selected line is commented, all selected lines are uncommented and vice versa.
[count]<leader>cm |NERDComMinimalComment| Comments the given lines using only one set of multipart delimiters.
[count]<leader>ci |NERDComInvertComment| Toggles the comment state of the selected line(s) individually.
[count]<leader>cs |NERDComSexyComment| Comments out the selected lines ``sexily''
[count]<leader>cy |NERDComYankComment| Same as <leader>cc except that the commented line(s) are yanked first.
<leader>c$ |NERDComEOLComment| Comments the current line from the cursor to the end of line.
<leader>cA |NERDComAppendComment| Adds comment delimiters to the end of line and goes into insert mode between them.
|NERDComInsertComment| Adds comment delimiters at the current cursor position and inserts between. Disabled by default.
<leader>ca |NERDComAltDelim| Switches to the alternative set of delimiters.
[count]<leader>cl [count]<leader>cb |NERDComAlignedComment| Same as |NERDComComment| except that the delimiters are aligned down the left side (<leader>cl) or both sides (<leader>cb).
[count]<leader>cu |NERDComUncommentLine| Uncomments the selected line(s).