A brackets extension to generate JS/PHPDocs for your functions.
- Open a JS or PHP file
- set your cursor on a function declaration
function cool(stuff)
- Use the ShortCut
Ctrl-Alt-D
(Win) orCtrl-Shift-D
(Mac) to start the documentation or/**
+ Enter
The extension will provide a function documentation:
Natural way: /**
+ Enter
With shortcut:
[[Description]]
will be selected so you can start to type. To jump to the next [[tag]]
you can use Tab
or jump to the last with Shift-Tab
. The indenting updates on a tab jump (live indenting).
You will get hints for the [[Type]]
tag.
Have fun and stay tuned!
Easy way to add @link tags to your docs!
- It's possible to generate the doc block with
/**
+ Enter. You only need to type/**
in the line above the function declaration and use enter to start the documentation.
- The padding for correct indentation updates on a tab jump
- It's possible to update a doc block if you add a parameter or delete one (you need to use the shortcut again)
- You get the tag
@returns
if the function returns a value - The
[[Type]]
is recognized if possible.