PHPDoc

Cet article est une ébauche concernant l’informatique.

Vous pouvez partager vos connaissances en l’améliorant (comment ?) selon les recommandations des projets correspondants.

PHPDoc

Informations
Type	Générateur de documentation
Site web	www.phpdoc.de et www.phpdoc.org

modifier - modifier le code - voir Wikidata (aide)

PHPDoc est une transposition de Javadoc au langage PHP. Il s'agit d'un standard formalisé pour commenter le code PHP. Il permet d'utiliser des outils tels que phpDocumentor ou Doxygen pour générer la documentation du code, notamment les méthodes publiques, les API, etc. Il permet aussi à certains IDE (Zend Studio (en), NetBeans, etc.) de connaître le type des variables et de lever d'autres ambiguïtés dues au typage faible, améliorant ainsi la complétion de code, le "typage objet"^[1] et le débogage.

En août 2013, le PHP Framework Interoperability Group (PHP-FIG) commence à travailler sur le PSR-5, dérivé du standard de facto de phpDocumentor, pour développer et formaliser le standard PHPDoc^[2].

Exemple

Les mots-clés PHPDoc commencent par une arobase^[3]. Par exemple @return indique les types possibles de la valeur retournée par une méthode :

 /**
  * @return string|null The file path or null when non-existent.
  */
 function getPath()
 {
     ...
     return $path;
 }

Références

↑ Documentation PHP FR : Typage objet
↑ PSR-5: PHPDoc (Draft)
↑ Site officiel

v · m PHP
Personnalités	Andi Gutmans Rasmus Lerdorf Zeev Suraski
Ressources	Accélérateur (Alternative PHP Cache, eAccelerator (en), MMCache (en)) Composer Éditeurs (en) Extensions (en) PHPDoc
Implémentations	HipHop Virtual Machine (en) (HHVM) HipHop for PHP Parrot Phalanger Quercus Zend Engine
Frameworks web	CakePHP CodeIgniter Drupal eZ Publish Fat-Free FuelPHP Horde Joomla! Laravel Lithium Midgard MODx Nette Framework PEAR Phalcon PRADO QCodo Silex SilverStripe Symfony TYPO3 WordPress Xaraya Xoops Yii Zend Framework Zeta Components
Test	Behat PHPUnit SimpleTest Lime (Symfony)
Mapping objet-relationnel	Doctrine Propel
Environnement de développement	Aptana Codelobster Eclipse PDT NetBeans PHPEdit PhpStorm RadPHP Zend Studio
Toolkit	PHP-GTK PHP-Qt wxPHP