Ist @return-Tag mit Rückgabetypdeklaration unbrauchbar?

Question

Ist phpdocs @return-Tag mit Rückgabetypdeklaration unbrauchbar? Mit anderen Worten ist es Vorteile in @return-Tag in diesem Fall:

/** 
* Example function. 
* 
* @return int 
*/ 
public function getOne(): int 
{ 
    return 1; 
} 

Sollten wir diese Anmerkung in PHP7 entfernen?

Answer 1

Sollten wir diese Anmerkung in PHP7 entfernen?

Während @return auf den ersten Blick redundant aussehen kann, ist es nicht. Es erlaubt Ihnen, eine detailliertere Beschreibung über den zurückgegebenen Wert, seine Bedeutung, nicht nur den Typ des Wertes zu geben, der im Falle von komplexeren Daten, die zurückgegeben werden (zB Arrays), ziemlich nutzlos ist, daher würde ich lieber etwas mehr Anstrengungen machen Docs besser mit dieser Funktion statt @return für keinen wirklichen Vorteil zu entfernen.

Answer 2

Wenn es ein int oder ein boolean zurückgibt, sollte Ihr Dokument sagen, dass es ein int oder boolean zurückgibt.

/** 
    * @return int 1 on success, 0 means failure 
*/ 

Answer 3

Wenn ein Klassenname als Datentyp in dem @return-Tag verwendet wird anstelle von ‚int‘, phpdoc automatisch einen Link zu dieser Klasse in der Dokumentation erstellen.

/** 
* Example function. 
* 
* @return className 
*/ 

Andere Anwendung, beschreibende Informationen über mehrere zurückgegebenen Werte setzen:

/** 
* Example function. 
* 
* @return int|string could be an int, could be a string 
*/