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
40 commits 7 branches 0 tags 792 KiB
JavaScript 100%
Find a file
benedikt willi a5bd28fcde Updated functionExpressionRegex to match values of type someObject.someFunction = function(p1, p2)
2014-03-26 17:13:22 +01:00
LICENCE Create LICENCE 2012-12-17 13:26:04 -08:00
main.js Updated functionExpressionRegex to match values of type someObject.someFunction = function(p1, p2) 2014-03-26 17:13:22 +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 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+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.