Brackets extension to generate JSDoc annotations
Find a file
2012-06-22 12:06:39 +02:00
main.js updated for brackets sprint10 2012-06-22 12:06:39 +02:00
README.md updated for brackets sprint10 2012-06-22 12:06:39 +02:00

Brackets JSDoc Annotate

A brackets extension to generate JSDoc annotations for your functions.

To install, place the annotate folder inside the brackets/src/extensions/user folder.

Compatible with Brackets Sprint10

Usage

Open a project in Brackets, place your cursor before a function definition, and select Annotate form the Edit menu.

This will create a JSDoc like annotation according to the function signature. It will add @private if the function starts with an underscore. It will create a @param for each parameter.

Known issues

Annotations are not correctly indented.

It will only work with function declared with the form function name ([parameters]) {}.

No @return is generated since the extension only looks at the function signature to generate the annotation, not its body.