forked from preservim/nerdcommenter
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Abel Martin
committed
Mar 26, 2012
1 parent
93cdbaf
commit f6a3b19
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
h1. Installation | ||
|
||
|
||
h1. Usage | ||
|
||
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). |