How to comment out a block of Python code in Vim

Question

I was wondering if there was any key mapping in Vim to allow me to indent certain lines of code  whether those lines have been selected in visual mode  or n lines above below current cursor position    So basically something that converts the following   def my fun x  y       return x   y   to   def my fun x  y        return x   y   I am okay with using either   or     for commenting out the relevant lines  Ideally  I would also like the same keymapping to uncomment the lines if the given lines have been commented out

User · Answer

I have the following lines in my  vimrc     comment line  selection with Ctrl-N Ctrl-N au BufEnter   py nnoremap   lt C-N gt  lt C-N gt     mn s     s             1  2 ge lt CR gt  noh lt CR gt  n au BufEnter   py inoremap   lt C-N gt  lt C-N gt      lt C-O gt mn lt C-O gt  s     s             1  2 ge lt CR gt  lt C-O gt  noh lt CR gt  lt C-O gt  n au BufEnter   py vnoremap   lt C-N gt  lt C-N gt     mn s     s             1  2 ge lt CR gt  noh lt CR gt gv n    uncomment line  selection with Ctrl-N N au BufEnter   py nnoremap   lt C-N gt n     mn s     s              1 2 ge lt CR gt  s      ge lt CR gt  noh lt CR gt  n au BufEnter   py inoremap   lt C-N gt n      lt C-O gt mn lt C-O gt  s     s              1 2 ge lt CR gt  lt C-O gt  s      ge lt CR gt  lt C-O gt  noh lt CR gt  lt C-O gt  n au BufEnter   py vnoremap   lt C-N gt n     mn s     s              1 2 ge lt CR gt gv s   n  r ge lt CR gt  noh lt CR gt gv n   The shortcuts preserve your cursor position and your comments as long as they start with    there is space after     For example     variable x x   0   After commenting     variable x  x   0   After uncomennting     variable x x   0

User · Answer

Highlight your block with  ShiftV  Comment the selected block out with   norm i   lower case i   To uncomment  highlight your block again  and uncomment with   norm  x  The  norm command performs an action for every selected line  Commenting will insert a   at the start of every line  and uncommenting will delete that

User · Answer

I usually sweep out a visual block   lt C-V gt    then search and replace the first character with      lt    gt s        Entering command mode with a visual block selected automatically places   lt     on the command line  I can then uncomment the block by sweeping out the same visual block and      lt    gt s

User · Answer

one way manually    set number  10 12s

User · Answer

A very minimal light weight plugin  vim-commentary   gcc to comment a line  gcgc to uncomment  check out the plugin page for more   v k j highlight the block then gcc to comment that block

User · Answer

No plugins or mappings required   Try the built-in  norm  command  which literally executes anything you want on every selected line   Add   Comments  1  shift V to visually select lines 2   norm i    Remove   Comments  1  visually select region as before 2   norm x   Or if your comments are indented you can do  norm  x  Notice that these are just ordinary vim commands being preceded by   norm  to execute them on each line   More detailed answer for using  norm  command in one of the answers here  What  39 s a quick way to comment uncomment lines in Vim

User · Answer

CtrlK for comment  Visual Mode     vnoremap  lt silent gt   lt C-k gt   s       lt cr gt  noh lt cr gt    CtrlU for uncomment  Visual Mode     vnoremap  lt silent gt   lt C-u gt   s       lt cr gt  noh lt cr gt

User · Answer

There are some good plugins to help comment uncomment lines  For example The NERD Commenter

User · Answer

Step 1  Go to the the first column of the first line you want to comment     Step 2  Press  Ctrl v and select the lines you want to comment     Step 3  Shift-I space  Enter Insert-at-left mode  type chars to insert   The selection will disappear  but all lines within it will be modified after Step 4      Step 4  Esc

User · Answer

There s a lot of comment plugins for vim - a number of which are multi-language - not just python  If you use a plugin manager like Vundle then you can search for them  once you ve installed Vundle  using e g     PluginSearch comment   And you will get a window of results  Alternatively you can just search vim-scripts for comment plugins

User · Answer

Frankly I use a tcomment plugin for that link  It can handle almost every syntax  It defines nice movements  using it with some text block matchers specific for python makes it a powerful tool

User · Answer

NERDcommenter is an excellent plugin for commenting which automatically detects a number of filetypes and their associated comment characters  Ridiculously easy to install using Pathogen   Comment with  lt leader gt cc  Uncomment with  lt leader gt cu  And toggle comments with  lt leader gt c lt space gt     The default  lt leader gt  key in vim is

User · Answer

You could add the following mapping to your  vimrc  vnoremap  lt silent gt     s      lt cr gt  noh lt cr gt  vnoremap  lt silent gt  -   s      lt cr gt  noh lt cr gt    Highlight your block with   Shift v     to comment your lines from the first column   -  to uncomment the same way

[python] How to comment out a block of Python code in Vim

Examples related to python

Examples related to vim

Examples related to editor