vim-better-comments

BetterComments extension will help you create more human-friendly comments in your code. I've borrowed the core idea from the Visual Studio plugin with the same name.

Configuration

You can tweak the behavior of BetterComments by setting a few variables in your vimrc file.

Colors

Change colors to your preferences by tweaking the provided highlight groups:

ErrorBetterComments
HighlightBetterComments
QuestionBetterComments
StrikeoutBetterComments
TodoBetterComments

Target languages

Syntax files authors usually prepend highlight groups with the name of the target language. BetterComments tries to expand those comment highlight groups definitions to detect meaningful matches. In some cases like, for example pangloss/vim-javascript, that naming convention is not followed. In such cases, you can overcome the mismatch providing a dictionary of aliases:

let g:bettercomments_language_aliases = { 'javascript': 'js' }

By default, all languages are targeted. You can change that behaviour by providing either a g:bettercomments_skipped list or a g:bettercomments_included list.

Bugs

Please report any bugs you may find on the GitHub issue tracker.

Contributing

Think you can make BetterComments better? Great!, contributions are always welcome.

Fork the project on GitHub and send a pull request.

License

BetterComments is licensed under the MIT license. See http://opensource.org/licenses/MIT

Happy hacking!

what is different to the original jbgutierrez vim-script?

Not much. I've changed a color. This repo is basically just to avoid pulling from somebody elses repo and then changing it to my liking evey time.