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 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 , 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[modifier | modifier le code]
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;
}
