How to toggle between comment and uncomment in Vim for Python code

Question

I wish to have a single command to toggle commenting in a line / block of python code.

I am using the following code in my .vimrc file:

" (un-)commenting
" comment line, selection with Ctrl-N,Ctrl-N
au BufEnter *.py nnoremap ,c mn:s/^\(\s*\)#*\(.*\)/\1#\2/ge<CR>:noh<CR>`n
au BufEnter *.py inoremap ,c <C-O>mn<C-O>:s/^\(\s*\)#*\(.*\)/\1#\2/ge<CR><C-O>:noh<CR><C-O>`n
au BufEnter *.py vnoremap ,c mn:s/^\(\s*\)#*\(.*\)/\1#\2/ge<CR>:noh<CR>gv`n
"
" " uncomment line, selection with Ctrl-N,N
au BufEnter *.py nnoremap ,u mn:s/^\(\s*\)#\([^ ]\)/\1\2/ge<CR>:s/^#$//ge<CR>:noh<CR>`n
au BufEnter *.py inoremap ,u <C-O>mn<C-O>:s/^\(\s*\)#\([^ ]\)/\1\2/ge<CR><C-O>:s/^#$//ge<CR><C-O>:noh<CR><C-O>`n
au BufEnter *.py vnoremap ,u mn:s/^\(\s*\)#\([^ ]\)/\1\2/ge<CR>gv:s/#\n/\r/ge<CR>:noh<CR>gv`n

(adapted from this StackOverflow entry)

but, is thee a way to have a toggle, that is, using the same shortcut to comment if it's uncommented or uncomment if it's commented?

Possible duplicate of What's a quick way to comment/uncomment lines in Vim? — Big McLargeHuge
– Big McLargeHuge, Commented Mar 30, 2018 at 15:57

tomodachi · Accepted Answer · 2024-11-08 21:23:55Z

5

There's also NERD Commenter from Scrooloose, the maker of NERD Tree. It seems to more extensive than vim-commentary.

The only map I use though is <leader>c<space> (,c for my config), toggling a comment.

edited Nov 8, 2024 at 21:23

tomodachi

3084 silver badges12 bronze badges

answered May 25, 2013 at 13:15

timss

10.3k4 gold badges38 silver badges56 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

meduz · Accepted Answer · 2018-04-03 00:42:29Z

4

You can use the vim-commentary plugin from Tim Pope. Then you can create a mapping, for example

nmap ,cc <Plug>CommentaryLine

With this mapping you can comment and uncomment with the same key sequence. It also automatically adapts to the file type. For not supported file types you can set commentstring manually.

The default mapping is gcc and it does exactly what you're looking for: toggle commented/uncommented.

edited Apr 3, 2018 at 0:42

meduz

4,3012 gold badges31 silver badges43 bronze badges

answered May 25, 2013 at 12:54

Marco

8891 gold badge7 silver badges24 bronze badges

1 Comment

glts Over a year ago

An excellent plugin. The default mapping is gcc and it does exactly what you're looking for: toggle commented/uncommented.

Collectives™ on Stack Overflow

How to toggle between comment and uncomment in Vim for Python code

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related