phpDoc

phpdocumentor

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.

https://fr.wikipedia.org/wiki/PHPDoc

• https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md
• https://docs.phpdoc.org/getting-started/your-first-set-of-documentation.html

<?php
// Un exemple de classe
class MaClasse
{
    /**
     * Fonction de test
     *
     * Le premier paramètre doit être un objet de type AutreClasse
     */
    public function test(AutreClasse $autreclasse) {
        echo $autreclasse->var;
    }
 
 
    /**
    * Une autre fonction de test
    *
    * Le premier paramètre doit être un tableau
    */
    public function test_array(array $input_array) {
        print_r($input_array);
    }
 
    /**
     * Le premier paramètre doit être un itérateur
     */
    public function test_interface(Traversable $iterator) {
        echo get_class($iterator);
    }
 
    /**
     * Le premier paramètre doit être une fonction de rappel (callable)
     */
    public function test_callable(callable $callback, $data) {
        call_user_func($callback, $data);
    }
}
 
// Un autre exemple de classe
class AutreClasse {
    public $var = 'Bonjour le monde!';
}
?>

http://www.php.net/manual/fr/language.oop5.typehinting.php