Valeur de phpdoc @return pour PHPUnit dataProvider

Question

Existe-t-il un moyen compatible phpdoc * d'exprimer les différentes valeurs renvoyées dans un dataUnit de PHPUnit?

Par exemple:

return array(
    array(false, 17, array(1,2)), 
    array(true, 19, array(1,2)), 
); 

Je voudrais écrire quelque chose de plus détaillé que @return array, qui exprime que la première valeur transmise à la méthode d'essai est un bool, le second est un entier, le troisième est un tableau (et aussi ce que chacune de ces valeurs représente).

* S'il n'y a pas de manière conforme, quelqu'un a-t-il des conseils sur la façon de documenter de manière claire?

Answer 1

La seule autre spécification pour les tableaux est ce qu'ils contiennent (si toujours le même type):

/** 
* @return array[] 
*/ 
function() { 
    // ... 
} 

Cette annotation exprime la fonction retourne un tableau de tableaux, vous pouvez trouver une discussion plus loin dans cette question :

PHPDoc type hinting for array of objects?

note: Pas tous les IDE sera en mesure d'interpréter

Pour de manière claire possible: À mon avis, vous pouvez toujours utiliser des blocs de code dans vos commentaires pour expliquer une partie de votre code:

/** 
* returns array with following structure: 
* <code> 
* array(
*  array(
*   (bool), (int), (array) 
* ) 
*) 
* </code> 
* 
* @return array[] 
*/ 

ou une explication similaire. Je suis sûr qu'il y a beaucoup de façons de donner aux autres développeurs un indice sur ce à quoi s'attendre. En fin de compte, il doit juste être compréhensible à un humain s'il n'est pas inclus dans les annotations habituelles.