vim-插件10-代码注释插件nerdcommenter

潇洒

发布于 2023-10-20 10:57:18

5730

发布于 2023-10-20 10:57:18

文章被收录于专栏：石头岛

前言

作用：对代码进行注释，NERD_commenter插件需要VIM7.0以上版本。

# 可查看该符号的说明文档
:help <Leader>

命令\cc 中的斜杠：\ 为<Leader>符，<Leader>也就是常说的Leader键在.vimrc中添加let mapleader = ","可将<Leader>符变为,或者其实键。

安装

注释插件 NERD_commenter 通过Plug插件进行安装。

Plug 'scrooloose/nerdcommenter'

然后执行

:PlugInstall

就可以安装完成。

使用注释

主要就两个操作： \cc 注释当前行和选中行 \cu 取消注释

这个插件包括 html 也可以注释有用的就这两个，其它大同小异。

其他注释

操作	说明
\cn	没有发现和\cc有区别
\c<空格>	如果被选区域有部分被注释，则对被选区域执行取消注释操作，其它情况执行反转注释操作
\cm	对被选区域用一对注释符进行注释，前面的注释对每一行都会添加注释
\ci	执行反转注释操作，选中区域注释部分取消注释，非注释部分添加注释
\cs	添加性感的注释，代码开头介绍部分通常使用该注释
\cy	添加注释，并复制被添加注释的部分
\c$	注释当前光标到改行结尾的内容
\cA	跳转到该行结尾添加注释，并进入编辑模式
\ca	\ca 转换注释的方式，比如： /**/和//
\cl、\cb	左对齐和左右对其，左右对其主要针对/**/

配置


"=================================
" nerdcommenter 代码注释，主要\cc \cu
"=================================
"add spaces after comment delimiters by default
let g:NERDSpaceDelims = 1
" python 自动的会多加一个空格
au FileType python let g:NERDSpaceDelims = 0

" Use compact syntax for prettified multi-line comments
let g:NERDCompactSexyComs = 1

" Align line-wise comment delimiters flush left instead of following code indentation
let g:NERDDefaultAlign = 'left'

" Set a language to use its alternate delimiters by default
let g:NERDAltDelims_java = 1

" 自定义格式
" let g:NERDCustomDelimiters = { 'c': { 'left': '/**','right': '*/' } }

" Allow commenting and inverting empty lines (useful when commenting a region)
let g:NERDCommentEmptyLines = 1

" Enable trimming of trailing whitespace when uncommenting
let g:NERDTrimTrailingWhitespace = 1

" Enable NERDCommenterToggle to check all selected lines is commented or not
let g:NERDToggleCheckAllLines = 1