Code Monkey home page Code Monkey logo

vim-better-comments's Introduction

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!

vim-better-comments's People

Contributors

jbgutierrez avatar

Watchers

Zibi Braniecki avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.