@phpdoc by Aram Baghdasaryan
@phpdoc akaDoxygen standard
What @phpdoc is?
@phpdoc by Aram Baghdasaryan
PHPDoc is an adaptation of Javadoc for the PHP programming language
@phpdoc by Aram Baghdasaryan
· documentation· relationships· diagrams· autocomplete
What it gives to us?
@phpdoc by Aram Baghdasaryan
We can apply @phpdoc
@phpdoc by Aram Baghdasaryan
· in context of a page
We can apply @phpdoc
@phpdoc by Aram Baghdasaryan
· in context of a page· in context of a class
We can apply @phpdoc
@phpdoc by Aram Baghdasaryan
· in context of a page· in context of a class· in context of a method
We can apply @phpdoc
@phpdoc by Aram Baghdasaryan
· in context of a page· in context of a class· in context of a method· in context of a properties & variables
We can apply @phpdoc
@phpdoc by Aram Baghdasaryan
short style/** … */
“long” style/** * … */
DocBlock syntax
@phpdoc by Aram Baghdasaryan
/** * This is a DocBlock comment */function() { ...}
First impression
@phpdoc by Aram Baghdasaryan
/** * @method type MethodName($param) * @property type propertyName * ... */
class specific @phpdoc
@phpdoc by Aram Baghdasaryan
/** * @method int exp($num) */class Number { ... }
$pass = new Number();$pass->exp(5);
@phpdoc method
@phpdoc by Aram Baghdasaryan
/** * @param type $param Description * @return type * @throws \Exception * ... */
method specific @phpdoc
@phpdoc by Aram Baghdasaryan
/** * @param \Domain\User $param */function ident($param) { ...}
@phpdoc param
@phpdoc by Aram Baghdasaryan
/** * @param User|bool $param */function ident($param) { if ($param) { $param->getName(); }}
@phpdoc param
@phpdoc by Aram Baghdasaryan
/** * @param User[]|\ArrayObject $param */function ident($param) { if ($param->count()) { foreach ($param as $item) { ... } }}
@phpdoc param
@phpdoc by Aram Baghdasaryan
/** * @return User[]|\ArrayObject $param */function getUserDomain() { ...}
@phpdoc return
@phpdoc by Aram Baghdasaryan
/** * @throws \Exception * @throws \CustomException */function interrupt() { throw new \CustomException(‘...’);}
@phpdoc throws
@phpdoc by Aram Baghdasaryan
/** * @var type $param Description * @name $var1 * @global type $var2 * ... */
variable specific @phpdoc
@phpdoc by Aram Baghdasaryan
/** * Important Method ... * * Usage: * <code> * $x = MyMethod($param); * $x->init(); * </code> */
HTML in descriptions
@phpdoc by Aram Baghdasaryan
Thank You!