https://github.com/chrisbra/vim-commentary

Comment some stuff
https://github.com/chrisbra/vim-commentary

Last synced: 26 days ago
JSON representation

Comment some stuff

• Host: GitHub
• URL: https://github.com/chrisbra/vim-commentary
• Owner: chrisbra
• Created: 2015-02-12T21:48:50.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-09-22T16:18:40.000Z (over 8 years ago)
• Last Synced: 2024-10-28T19:55:02.100Z (2 months ago)
• Language: VimL
• Size: 34.2 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# commentary.vim

## initial Version

This is based on the [vim-commentary](https://github.com/tpope/vim-commentary)

plugin from Tim Pope.

This one is more advanced and toggles comments if they do not have a trailing space.

As no one was interested in this functionality (issues [#3][3], [#32][32], [#33][33] and [#40][40])

I forked Tim Popes version and leave it here.

## 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), `gc` in visual mode to comment out the selection,

and `gc` in operator pending mode to target a comment.  You can also use

it as a command, either with a range like `:7,17Commentary`, or as part of a

`:global` invocation like with `:g/TODO/Commentary`. That's it.

Oh, and it uncomments, too.  The above maps actually toggle, and `gcgc`

uncomments a set of adjacent commented lines.

## Installation

If you don't have a preferred installation method, I recommend

installing [pathogen.vim](https://github.com/tpope/vim-pathogen), and

then simply copy and paste:

    cd ~/.vim/bundle

    git clone git://github.com/chrisbra/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

## Self-Promotion

Like commentary.vim? Follow the repository on

[GitHub](https://github.com/chrisbra/vim-commentary)

## License

See `:help license`.

  [3]: https://github.com/tpope/vim-commentary/issues/3

 [32]: https://github.com/tpope/vim-commentary/issues/32

 [33]: https://github.com/tpope/vim-commentary/issues/33

 [40]: https://github.com/tpope/vim-commentary/issues/40