Update README.md

This commit is contained in:
Raja Kapur 2012-10-07 14:48:45 -03:00
parent b94591c381
commit 64e1a293a7

View file

@ -10,7 +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.
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.