PHPDoc aka Doxygen standard

@phpdoc by Aram Baghdasaryan
@phpdoc aka
Doxygen standard

What @phpdoc is?
PHPDoc is an adaptation of Javadoc for the
PHP programming language

· documentation
· relationships
· diagrams
· autocomplete
What it gives to us?

We can apply @phpdoc

· in context of a page

· in context of a class

· in context of a method

· in context of a method
· in context of a properties & variables

short style
/** … */
“long” style
/**
* …
*/
DocBlock syntax

/**
* This is a DocBlock comment
*/
function() {
...
}
First impression

/**
* @method type MethodName($param)
* @property type propertyName
* ...
*/
class specific @phpdoc

/**
* @method int exp($num)
*/
class Number { ... }
$pass = new Number();
$pass->exp(5);
@phpdoc method

/**
* @param type $param Description
* @return type
* @throws Exception
* ...
*/
method specific @phpdoc

/**
* @param DomainUser $param
*/
function ident($param) {
...
}
@phpdoc param

/**
* @param User|bool $param
*/
if ($param) {
$param->getName();
}
}
@phpdoc param

/**
* @param User[]|ArrayObject $param
*/
if ($param->count()) {
foreach ($param as $item) { ... }
}
}
@phpdoc param

/**
* @return User[]|ArrayObject $param
*/
function getUserDomain() {
...
}
@phpdoc return

/**
* @throws Exception
* @throws CustomException
*/
function interrupt() {
throw new CustomException(‘...’);
}
@phpdoc throws

/**
* @var type $param Description
* @name $var1
* @global type $var2
* ...
*/
variable specific @phpdoc

/**
* Important Method ...
*
* Usage:
* <code>
* $x = MyMethod($param);
* $x->init();
* </code>
*/
HTML in descriptions

Thank You!

Recommandé