107.03.13 vim commenter 介紹

aben20807/vim-commenter
感覺就算寫了 README、寫了 doc 還是沒人看啊 QuQ
雖然在這裡介紹也差不多 QuQ
有 GitHub 的可以順手按個星星之類的,我會很感激 QuQ
不過還是想用繁體中文寫一個超完整(?)的介紹
總之,目前寫了3個 plugin 了,沒意外就各來一篇 OuO

為什麼叫做 commenter?

1. 我懶得註解都要按"I"移到前面然後再打"// "
2. 很多 IDE 都有 ctrl+/ 就可以單行註解
3. 找到 nerdcommenter 可是案件太複雜懶得記
4. 總之就是懶OuO
5. 所以這個 commenter 就是專門用來註解的~~~~ OuO

安裝

我覺得 Vim-Plug 頗好用,有 On-demand loading 就是好 OuO
所以這裡就記這個 plugin 管理器的方法:
把下面這行加入 .vimrc 裡面
Plug 'aben20807/vim-commenter'
打開 vim 輸入下面指令就可以了
:PlugInstall
其他像是 Vim-Plug 怎麼安裝,其他的管理器 e.g. 怎麼用 Vundle 裝 plugin 就自己找了喔 OuO

使用方式

安裝完後就可以直接使用 alt+/ 進行註解 (因為 vim 不支援 ctrl+/ @@
當然目前只支援 C, C++, Html, Java, Makefile, Python, Rust, Shell script, Vim script 這些
想多加語言可以使用自訂或是PR,都不會就跟我說吧,我再加 OuO

在 normal、insert 模式都支援喔

insert 模式下按了註解後仍然會保持 insert 模式 OuO

也支援 visual 模式下註解

visual 模式 (shift+v) 多行註解

visual 模式 (ctrl+v) 區塊註解


可自訂變數

是否使用預設的按鍵,預設值是 1 就是有使用
let g:commenter_use_default_mapping = 1
可以自訂觸發的按鍵,三個模式預設都是 Alt+/
let g:commenter_n_key = "<M-/>"
let g:commenter_i_key = "<M-/>"
let g:commenter_v_key = "<M-/>"
是否在 visual 模式註解後保持選取,預設是不打開,想用就把這個變數設成 1
let g:commenter_keep_select = 0
使用區塊註解,有些語言有所謂的區塊註解 e.g. C: /* */
預設是有區塊註解時就使用,如果只想要整行註解可以把此變數設為 0
let g:commenter_use_block_comment = 1
使用區塊註解,有些語言有支援巢狀區塊註解 e.g. Rust: /* /* */ */
let g:commenter_allow_nest_block = 0
可以自訂想要的註解格式
以 html 為例,ll (整行註解的左邊),bl (區塊註解的左邊),br (區塊註解的右邊)
如果不喜歡預設的格式也可以修改,例如可以把 C 的 'll' 設成 '// OuO '
let g:commenter_custom_map = {'html': { 'll': '', 'bl': '' }}
是否顯示註解訊息,看上面的 gif 就可以看到下面都會有中文字提示,想關掉就設成 0 吧
let g:commenter_show_info = 1


已知問題

visual 模式下不能恢復光標位置

沒有留言:

張貼留言

^ Top