前言

最近使用VIM感觉比较强大,但是快速注释一直困扰着我之前在网上也看到有很多老铁推荐NERD Commenter插件这款插件,但是基本都没有中文的配置方法和操作说明,无赖英语一窍不通的我对官方的README.md也看得一脸懵逼,最终还是在借助翻译工具的情况下客服了这个困难。现在我把翻译的结果(加了一些注解)做为自己的笔记也分享给大家参考。

.vimrc配置

" 默认情况下,在注释分隔符后添加空格
let g:NERDSpaceDelims = 1

" 对美化的多行注释使用压缩语法(貌似这个没什么卵用)
let g:NERDCompactSexyComs = 1

" 按行对齐注释分隔符左对齐,而不是按代码缩进
let g:NERDDefaultAlign = 'left'

" 默认情况下,将语言设置为使用其备用分隔符(不是很明白所以忽略)
let g:NERDAltDelims_java = 1

" 添加您自己的自定义格式或覆盖默认格式(你懂的)
let g:NERDCustomDelimiters = { 'php': { 'left': '/*','right': '*/' },'html': { 'left': '<!--','right': '-->' },'py': { 'left': '#' },'sh': { 'left': '#' } }

" 允许注释和反转空行(在注释区域时很有用) (没亲测)
let g:NERDCommentEmptyLines = 1

" 取消注释时启用尾随空白的修剪
let g:NERDTrimTrailingWhitespace = 1

" 启用nerdcommenttoggle检查是否对所有选定行进行了注释
let g:NERDToggleCheckAllLines = 1

操作说明

    [count]<leader>cc |NERDCommenterComment|
	注释掉在视觉模式下选定的当前行或文本。 对应我的 ,cc 
	
    [count]<leader>cn |NERDCommenterNested|
	与cc相同,但强制嵌套。 (没试验过) 对应我的 ,cn
	
    [count]<leader>c<space> |NERDCommenterToggle|
	换选定行的注释状态。如果最上面的选定行被注释,则所有选定行都将被取消注释,反之亦然。 
	对应我的 ,c<space> (注释与取消注释)  每一行都添加一组注释符  
	我目前使用 ,cm注释 使用 ,c<space>取消注释
    [count]<leader>cm |NERDCommenterMinimal|
	仅使用一组多部分分隔符注释给定行。 (这个也就是多行注释只用一个注释标签的意思 例如 /* sdfasdfdfds */ ) 对应我的 ,cm

    [count]<leader>ci |NERDCommenterInvert|
	分别切换选定行的注释状态。

    [count]<leader>cs |NERDCommenterSexy|
	用漂亮的块格式布局注释掉所选行。

    [count]<leader>cy |NERDCommenterYank|
	与cc相同,不同的是,注释行首先被拉伸。

    <leader>c$ |NERDCommenterToEOL|
	注释光标到行尾的当前行。

    <leader>cA |NERDCommenterAppend|
	在行尾添加注释分隔符,并在它们之间进入插入模式。

    |NERDCommenterInsert|
	在当前光标位置添加注释分隔符并在两者之间插入。默认情况下禁用。 (默认没有快捷键)

    <leader>ca |NERDCommenterAltDelims|
	切换到另一组分隔符。

    [count]<leader>cl |NERDCommenterAlignLeft [count]<leader>cb |NERDCommenterAlignBoth
	与| nerdcommentercomment |相同,只是分隔符沿左侧(<leader>cl)或两侧(<leader>cb)对齐。

    [count]<leader>cu |NERDCommenterUncomment|
	取消对选定行的注释。

踩坑

我在注释的时候遇到如下问题:

NERDCommenter:filetype plugins should be enabled. See :help NERDComInstallation
and :help :filetype-plugin-on
Press ENTER or type command to continue
百度一圈没找到解决方案,最后发现官方文档有说这个问题,但是没说对应报错。

Post Installation

Make sure that you have filetype plugins enabled, as the plugin makes use of |commentstring| where possible (which is usually set in a filetype plugin). See |filetype-plugin-on| for details, but the short version is make sure this line appears in your vimrc:

百度翻译结果如下:

确保启用了filetype插件,因为插件尽可能使用| commentstring |(通常在filetype插件中设置)。有关详细信息,请参阅| filetype plugin on |,但简短的版本是确保此行显示在您的vimrc中:

G哥翻译结果:

确保您已启用文件类型插件,因为该插件使用了| commentstring |。在可能的情况下(通常在文件类型插件中设置)。参见| filetype-plugin-on |有关详细信息,但简短的版本是确保此行出现在您的vimrc中:

填坑
  • 本来英语水平就不好的我看到这翻译结果突然感觉我的中文水平也不过关了,话说你直接给个解决方案就好了呀,为什么高数我 “请参阅| filetype plugin on |有关详细信息”。最后我才明白参加就是要使用这个命令。
  • 说了这么多废话最后解决方案奉上:
 # ~/.vimrc 文件中添加如下代码即可解决
filetype plugin on

最后

好了我要去小学重新提升一下我的汉语水平了。如果有什么问题欢迎评论区留言。

更多配置请看本人.vimrc配置文件git仓库 本人VIM配置文件