52

GitHub - jbgutierrez/vim-better-comments: Easily highlight human-friendly commen...

 5 years ago
source link: https://github.com/jbgutierrez/vim-better-comments
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

README.md

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 hightlight groups:

ErrorBetterComments
HighlightBetterComments
QuestionBetterComments
StrikeoutBetterComments
TodoBetterComments

Target languages

By default, the comments in all languages are handled. 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!


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK