Hopiu/annotate-extension
1
0
Fork 0
mirror of https://github.com/Hopiu/annotate-extension.git synced 2026-03-16 16:10:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Brackets extension to generate JSDoc annotations
46 commits 7 branches 0 tags 792 KiB
JavaScript 100%
Find a file
David Deraedt d68e2cadca Merge pull request #25 from Hopiu/expressionRegex2 
Expression regex2
2014-03-27 15:18:10 +01:00
LICENCE Create LICENCE 2012-12-17 13:26:04 -08:00
main.js Added support for other function definitions 2014-03-27 10:35:33 +01:00
package.json upadated version number and readme 2014-03-26 10:30:02 +01:00
README.md upadated version number and readme 2014-03-26 10:30:02 +01:00
test_dummy.js Added pseudo testcases 2014-03-27 10:19:05 +01: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+Alt+A on Windows, or ⌘+Alt+A 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.