*For simplicity, let's use **[VIMROOT]** which will mean ~/.vim (*nix) or ~/vimfiles (Windows)_
The NERD Commenter requires Vim 7 or higher is comprised of 2 files:
- Extract the plugin files into your [VIM_ROOT]/plugin and [VIM_ROOT]/doc folders respectively.
- Finish the install by updating your help files. Run:
See |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.
Comment out the current line or text selected in visual mode.
Same as <leader>cc but forces nesting.
Toggles the comment state of the selected line(s). If the topmost selected line is commented, all selected lines are uncommented and vice versa.
Comments the given lines using only one set of multipart delimiters.
Toggles the comment state of the selected line(s) individually.
Comments out the selected lines ``sexily''
Same as <leader>cc except that the commented line(s) are yanked first.
Comments the current line from the cursor to the end of line.
Adds comment delimiters to the end of line and goes into insert mode between them.
Adds comment delimiters at the current cursor position and inserts between. Disabled by default.
Switches to the alternative set of delimiters.
Same as |NERDComComment| except that the delimiters are aligned down the left side (<leader>cl) or both sides (<leader>cb).
Uncomments the selected line(s).