Skip to content

timosandberg/reasonable-comments

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Reasonable Comments for Brackets

Simple enhancements for typing block comments in Brackets: when you press Enter, the next line is automatically prefixed with a properly indented "*". So for example, instead of this:

    /**
|
     */

You'll get this:

    /**
     * |
     */

It also closes the comment automatically when you press Enter, if needed. So when you press Enter here:

    /**|

You'll get this:

    /**
     * |
     */

Text after cursor is inserted inside comment

    /**|foo bar

And you'll get:

    /**
     * |foo bar
     */

Supports any language that uses /* ... */-style comments.

Simple predefined YUIDoc/Javadoc/PHPDoc-style comments for function and class. Just make sure the function/class defining row is right below when pressing Enter.

    /**|
    function foo(bar) {

To get:

    /**
     * function description
     *
     * @method foo
     * @param {Type} bar
     * @return {Type}
     */
    function foo(bar) {    

Or:

    /**|
    class Foo { 

To get:

    /**
     * class description
     *
     * @class Foo
     * @author Your Name <email>
     * @constructor
     */
    class Foo {

How to Install

Reasonable Comments is an extension for Brackets, a new open-source code editor for the web.

To install extensions:

  1. Choose File > Extension Manager and select the Available tab
  2. Search for this extension
  3. Click Install!

License

MIT-licensed -- see main.js for details.

Compatibility

Brackets Sprint 21 or newer (or Adobe Edge Code Preview 4 or newer).

About

Simple enhancement for typing Enter in block comments in Brackets

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%