Skip to content

jolson474/annotate-extension

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

Known issues

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

About

Brackets extension to generate JSDoc annotations

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%