Hopiu/annotate-extension
1
0
Fork 0
mirror of https://github.com/Hopiu/annotate-extension.git synced 2026-03-28 04:20:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Brackets extension to generate JSDoc annotations
7 commits 7 branches 0 tags 792 KiB
JavaScript 100%
Find a file
Raja Kapur 8527e4d8ff Added support for php functions and whitespaces 
Previously the cursor could not be in the middle of the line or the extension would error out saying function not found.

The getTarget() function now checks from the start of the line, and generateComment() now prefixes the comment block with the same whitespace spaces or tabs as the function def line used
2012-10-07 14:27:01 -03:00
main.js Added support for php functions and whitespaces 2012-10-07 14:27:01 -03:00
README.md Added support for function expressions 2012-09-24 10:06:31 +02:00
test_dummy.js Added a test file 2012-09-24 10:12:13 +02:00

README.md

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.

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