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

Update README.md

Browse source
This commit is contained in:
Raja Kapur 2012-10-07 14:48:00 -03:00
parent 6fa22d87c9
commit b94591c381
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -10,6 +10,7 @@ To install, place the ```annotate``` folder inside the ```brackets/src/extension
Usage
=====
Open a project in Brackets, place your cursor before 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.