ylib/nerdcommenter
1
0
Fork 0
mirror of https://github.com/preservim/nerdcommenter.git synced 2025-01-19 20:32:45 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc the new NERDCustomDelimiters option

Browse Source
This commit is contained in:
Martin Grenfell 2011-02-06 09:22:37 +13:00
parent 90cf828ac0
commit f8be02f10a
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/NERD_commenter.txt
View File

@ -404,6 +404,8 @@ then the script would do a sexy comment on the last visual selection.
doing visual-block comments.
|'NERDCommentWholeLinesInVMode'| Changes behaviour of visual comments.
|'NERDCreateDefaultMappings'| Turn the default mappings on/off.
|'NERDCustomDelimiters'| Add or override delimiters for any
filetypes.
|'NERDDefaultNesting'| Tells the script to use nested comments
by default.
|'NERDMenuMode'| Specifies how the NERD commenter menu
@ -550,7 +552,7 @@ Note that this option does not affect the behaviour of commenting in
|visual-block| mode.
------------------------------------------------------------------------------
*'NERDCreateDefaultMappings'*
*'NERDCreateDefaultMappings'*
Values: 0 or 1.
Default: 1.
@ -558,6 +560,25 @@ If set to 0, none of the default mappings will be created.
See also |NERDComMappings|.
------------------------------------------------------------------------------
*'NERDCustomDelimiters'*
Values: A map (format specified below).
Default: {}
Use this option if you have new filetypes you want the script to handle, or if
you want to override the default delimiters of a filetype.
Example: >
let g:NERDCustomDelimiters = {
\ 'ruby': { 'left': '#', 'leftAlt': 'FOO', 'rightAlt': 'BAR' },
\ 'grondle': { 'left': '{{', 'right': '}}' }
\ }
<
Here we override the delimiter settings for ruby and add FOO/BAR as alternative
delimiters. We also add {{ and }} as delimiters for a new filetype called
'grondle'.
------------------------------------------------------------------------------
*'NERDRemoveAltComs'*
Values: 0 or 1.