Hopiu/annotate-extension
1
0
Fork 0
mirror of https://github.com/Hopiu/annotate-extension.git synced 2026-04-23 08:04:48 +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:57:43 -03:00
parent 64e1a293a7
commit 090d30d406
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -9,7 +9,8 @@ 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.
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`+`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.