PHPDoc aka Doxygen standard
0 likes1,216 views
@phpdoc is an adaptation of Javadoc for PHP documentation that allows developers to generate documentation from code comments. It provides documentation, relationships between code elements, diagrams, and autocomplete capabilities. @phpdoc comments called DocBlocks can be added in code to document pages, classes, methods, properties, variables, parameters, and returns. The DocBlock syntax starts with /** and supports HTML for descriptions.
![@phpdoc by Aram Baghdasaryan
/**
* @param User[]|ArrayObject $param
*/
function ident($param) {
if ($param->count()) {
foreach ($param as $item) { ... }
}
}
@phpdoc param](https://image.slidesharecdn.com/doxygen-140603085751-phpapp02/85/PHPDoc-aka-Doxygen-standard-16-320.jpg)
![@phpdoc by Aram Baghdasaryan
/**
* @return User[]|ArrayObject $param
*/
function getUserDomain() {
...
}
@phpdoc return](https://image.slidesharecdn.com/doxygen-140603085751-phpapp02/85/PHPDoc-aka-Doxygen-standard-17-320.jpg)
PHPDoc aka Doxygen standard
- 1. @phpdoc by Aram Baghdasaryan @phpdoc aka Doxygen standard
- 2. What @phpdoc is? @phpdoc by Aram Baghdasaryan PHPDoc is an adaptation of Javadoc for the PHP programming language
- 3. @phpdoc by Aram Baghdasaryan · documentation · relationships · diagrams · autocomplete What it gives to us?
- 4. @phpdoc by Aram Baghdasaryan We can apply @phpdoc
- 5. @phpdoc by Aram Baghdasaryan · in context of a page We can apply @phpdoc
- 6. @phpdoc by Aram Baghdasaryan · in context of a page · in context of a class We can apply @phpdoc
- 7. @phpdoc by Aram Baghdasaryan · in context of a page · in context of a class · in context of a method We can apply @phpdoc
- 8. @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
- 9. @phpdoc by Aram Baghdasaryan short style /** … */ “long” style /** * … */ DocBlock syntax
- 10. @phpdoc by Aram Baghdasaryan /** * This is a DocBlock comment */ function() { ... } First impression
- 11. @phpdoc by Aram Baghdasaryan /** * @method type MethodName($param) * @property type propertyName * ... */ class specific @phpdoc
- 12. @phpdoc by Aram Baghdasaryan /** * @method int exp($num) */ class Number { ... } $pass = new Number(); $pass->exp(5); @phpdoc method
- 13. @phpdoc by Aram Baghdasaryan /** * @param type $param Description * @return type * @throws Exception * ... */ method specific @phpdoc
- 14. @phpdoc by Aram Baghdasaryan /** * @param DomainUser $param */ function ident($param) { ... } @phpdoc param
- 15. @phpdoc by Aram Baghdasaryan /** * @param User|bool $param */ function ident($param) { if ($param) { $param->getName(); } } @phpdoc param
- 16. @phpdoc by Aram Baghdasaryan /** * @param User[]|ArrayObject $param */ function ident($param) { if ($param->count()) { foreach ($param as $item) { ... } } } @phpdoc param
- 17. @phpdoc by Aram Baghdasaryan /** * @return User[]|ArrayObject $param */ function getUserDomain() { ... } @phpdoc return
- 18. @phpdoc by Aram Baghdasaryan /** * @throws Exception * @throws CustomException */ function interrupt() { throw new CustomException(‘...’); } @phpdoc throws
- 19. @phpdoc by Aram Baghdasaryan /** * @var type $param Description * @name $var1 * @global type $var2 * ... */ variable specific @phpdoc
- 20. @phpdoc by Aram Baghdasaryan /** * Important Method ... * * Usage: * <code> * $x = MyMethod($param); * $x->init(); * </code> */ HTML in descriptions
- 21. @phpdoc by Aram Baghdasaryan Thank You!