mirror of
https://github.com/Hopiu/annotate-extension.git
synced 2026-04-26 01:24:46 +00:00
24 lines
No EOL
879 B
Markdown
Executable file
24 lines
No EOL
879 B
Markdown
Executable file
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.
|
|
|
|
It will only work with function declared with the form ```function name ([parameters]) {}```.
|
|
|
|
No ```@return``` is generated since the extension only looks at the function signature to generate the annotation, not its body. |