sponsor Vim development Vim logo Vim Book Ad

commentary.vim : Comment stuff out; takes a motion as a target

 script karma  Rating 149/144, Downloaded by 1000    Comments, bugs, improvements  Vim wiki

created by
Tim Pope
 
script type
utility
 
description
Comment stuff out.  Use gcc to comment out a line (takes a count), gc to comment out the target of a motion (for example, gcap to comment out a paragraph), and gc in visual mode to comment out the selection.  That's it.

I wrote this because 5 years after Vim added support for mapping an operator, I still couldn't find a commenting plugin that leveraged that feature (I overlooked vimscript #1173).  Striving for minimalism, the first version weighs in at just 35 lines of code.

Oh, and it uncomments, too.  The above maps actually toggle, and `gcu` uncomments a set of adjacent commented lines.  Install repeat.vim, vimscript #2136, to enable repeating with . the line commenting map gcu.  (The other maps are repeatable without it.)

https://github.com/tpope/vim-commentary
 
install details
You know the drill.
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
commentary.zip 1.2 2014-03-10 7.0 Tim Pope Switch official interface from \\ to gc. \\ still works.
Allow overriding 'commentstring' with b:commentary_format.
Add User CommentaryPost callback.
commentary.zip 1.1 2011-08-28 7.0 Tim Pope Smarter indentation handling.
Always pad with whitespace.
Support nesting: /* /1* abc *1/ */.
Support custom maps.
commentary.zip 1.0 2011-08-20 7.0 Tim Pope Initial upload
ip used for rating: 54.161.236.229

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
SourceForge.net Logo