Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aben20807/vim-commenter
A simple Vim plugin which uses <alt+/> to comment code.
https://github.com/aben20807/vim-commenter
comment vim vim-plugin
Last synced: about 5 hours ago
JSON representation
A simple Vim plugin which uses <alt+/> to comment code.
- Host: GitHub
- URL: https://github.com/aben20807/vim-commenter
- Owner: aben20807
- License: mit
- Created: 2018-01-27T13:26:27.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-06T03:16:23.000Z (about 1 year ago)
- Last Synced: 2023-11-06T04:25:21.220Z (about 1 year ago)
- Topics: comment, vim, vim-plugin
- Language: Vim Script
- Homepage: https://aben20807.blogspot.tw/2018/03/1070313-vim-commenter.html
- Size: 55.7 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Commenter [](https://travis-ci.org/aben20807/vim-commenter) [](https://raw.githubusercontent.com/aben20807/vim-commenter/master/LICENSE)
## 1. Installation
### 1.a. Installation with [Vim-Plug](https://github.com/junegunn/vim-plug)
1. Add `Plug 'aben20807/vim-commenter'` to your vimrc file.
2. Reload your vimrc or restart.
3. Run `:PlugInstall`
### 1.b. Installation with [Vundle](https://github.com/VundleVim/Vundle.vim)
1. Add `Plugin 'aben20807/vim-commenter'` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:PluginInstall`
## 2. Usage
### 2.a. Supported Languages
+ c, conf, cpp, css, gnuplot, html, htmlm4, java, javascript, lex,
+ lisp, make, prolog, python, rust, sh, tmux, vader, vim, yacc
### 2.b. Block comment
+ In v or ^v(ctrl-v) mode will use block comment.
+ e.g. C: `/* comment here */`
### 2.c. Settings
```vim
" Use key mappings setting from this plugin by default.
let g:commenter_use_default_mapping = 1
" Use namely Alt+/ to toggle comment in n, i, v mode by default.
" Feel free to change mapping you like.
let g:commenter_n_key = ""
let g:commenter_i_key = ""
let g:commenter_v_key = ""
" Not keep selected part after commenting by default.
let g:commenter_keep_select = 0
" Use block comment by default, if 0 then only use line comment.
let g:commenter_use_block_comment = 1
" Not allow nest block comment by default.
" But some language (e.g. Rust) allow to use.
let g:commenter_allow_nest_block = 0
" Custom comment map by setting g:commenter_custom_map, not setting by default.
" ll: line comment left, bl: block comment left, br: block comment right.
" e.g.
let g:commenter_custom_map =
\ {'ouo': { 'll': 'QuQ', 'bl': '/OuO ', 'br': ' OuO/' }}
" Show the comment information by default.
let g:commenter_show_info = 1
" Trim leading and trailing white spaces when searching comment by default.
" For example: `/* ` will search `/*`, it is good to avoid without space
" in sometimes leaded comment not be detected.
let g:commenter_trim_whitespace = 1
" Allow comment the empty line by default
let g:commenter_comment_empty = 1
```
