Sublime Text 2 Comment/Doc Block

phpdoc sublimetext
Taha picture Taha · Sep 20, 2011 · Viewed 30.5k times · Source

Recently, I decided to try out Sublime Text 2 as a TextMate alternative (which it is). I'm absolutely loving it but the only issue that bugs me is that it doesn't continue the PHP Comment/Doc Block upon pressing "Enter".

It just adds new blank lines instead of lines starting with "* " as seen here http://cl.ly/AFcP/o

Is there a solution to this? I tried doing a key binding for it but it was just too complicated for me, especially because I'm not too experienced with the editor.

Thanks in advance.

Answer

Clint picture Clint · Nov 20, 2011

And now an even better solution has become available:

https://github.com/spadgos/sublime-jsdocs

It is called DocBlockr, and it has PHPDoc support. It automatically adds the doc block based on the function parameters. Nice...

Related questions

PHPDoc type hinting for array of objects?

So, in PHPDoc one can specify @var above the member variable declaration to hint at its type. Then an IDE, for ex. PHPEd, will know what type of object it's working with and will be able to provide a code …

Read More
PHP Function Comments

Just a quick question: I've seen that some PHP functions are commented at the top, using a format that is unknown to me: /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ My IDE …

Read More
Best way to document Array options in PHPDoc?

I'm struggling to write readable and easy to understand documentation that describes the multi-tree structure for Array options that are passed to a function. Here is an example array structure. $arr = [ 'fields' => [ 'title' => [ 'name' => 'Document.title', 'format' =&…

Read More