La balise @return de phpdoc est-elle inutile avec déclaration de type de retour? Autrement dit, est-il des avantages en @return tag dans ce cas:La balise @return est-elle inutile avec la déclaration de type de retour
/**
* Example function.
*
* @return int
*/
public function getOne(): int
{
return 1;
}
Faut-il supprimer cette annotation dans PHP7?
Faut-il supprimer cette annotation dans PHP7?
Alors que @return peut sembler redondant à première vue, ce n'est pas le cas. Il vous permet de mettre plus de détails sur la valeur retournée, sa signification, et pas seulement le type de valeur qui peut être inutile dans le cas de données plus complexes renvoyées (ie des tableaux), donc je vais plutôt mettre plus d'efforts pour faire docs mieux en utilisant cette fonctionnalité au lieu de supprimer @return sans réel avantage.
S'il renvoie un int ou un booléen, votre doc doit indiquer qu'il renvoie un int ou un booléen.
/**
* @return int 1 on success, 0 means failure
*/
Si un nom de classe est utilisé comme type de données dans la balise @return au lieu de « int », phpdoc crée automatiquement un lien vers la documentation de cette classe.
/**
* Example function.
*
* @return className
*/
Autre application, pour définir des informations descriptives sur plusieurs valeurs retournées:
/**
* Example function.
*
* @return int|string could be an int, could be a string
*/