Hopiu/annotate-extension
1
0
Fork 0
mirror of https://github.com/Hopiu/annotate-extension.git synced 2026-03-17 00:10:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Brackets extension to generate JSDoc annotations
14 commits 7 branches 0 tags 792 KiB
JavaScript 100%
Find a file
David Deraedt 270e33123d Merge pull request #5 from aonic/master 
Fixed indentation issue, and added PHP functions and hotkey support
2012-10-08 00:42:21 -07:00
main.js Added Ctrl/Cmd+Shift+D keyboard shortcut 2012-10-07 14:45:02 -03:00
README.md Usage info and compatibility update 2012-10-07 14:58:19 -03: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 and higher

Usage

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

Alternatively, use the keyboard shortcut CTRL+Shift+D on Windows, or ⌘+Shift+D on Mac.

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

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