phpdoc

PHP function comments

by

Functions: /** * Does something interesting * * @param Place $where Where something interesting takes place * @param integer $repeat How many times something interesting should happen * * @throws Some_Exception_Class If something interesting cannot happen * @author Monkey Coder <mcoder@facebook.com> * @return Status */ Classes: /** * Short description for class * * Long … Read more

PHPDoc type hinting for array of objects?

by

In the PhpStorm IDE from JetBrains, you can use /** @var SomeObj[] */, e.g.: /** * @return SomeObj[] */ function getSomeObjects() {…} The phpdoc documentation recommends this method: specified containing a single type, the Type definition informs the reader of the type of each array element. Only one Type is then expected as element for … Read more