Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
commentary.vim: comment stuff out
VimL
Tree: 50b0556335

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
doc
plugin
.gitignore
README.markdown

README.markdown

commentary.vim

Comment stuff out. Use \\\ to comment out a line (takes a count), \\ to comment out the target of a motion (for example, \\ap to comment out a paragraph), and \\ in visual mode to comment out the selection. That's it.

Install repeat.vim to enable repeating with . the line commenting map \\\.

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 tcomment.vim). Striving for minimalism, it weighs in at under 100 lines of code.

Oh, and it uncomments, too. The above maps actually toggle, and \\u uncomments a set of adjacent commented lines.

Installation

If you don't have a preferred installation method, I recommend installing pathogen.vim, and then simply copy and paste:

cd ~/.vim/bundle
git clone git://github.com/tpope/vim-commentary.git

Once help tags have been generated, you can view the manual with :help commentary.

FAQ

My favorite file type isn't supported!

Relax! You just have to adjust 'commentstring':

autocmd FileType apache set commentstring=#\ %s

Contributing

See the contribution guidelines for pathogen.vim.

Self-Promotion

Like commentary.vim? Follow the repository on GitHub and vote for it on vim.org. And if you're feeling especially charitable, follow tpope on Twitter and GitHub.

License

Copyright (c) Tim Pope. Distributed under the same terms as Vim itself. See :help license.

Something went wrong with that request. Please try again.