Gibt es eine PHP-Doc-Syntax für "Funktion ändert Argument durch Verweis übergeben"?

Question

Wenn ein PHP-doc für eine Funktion zu schreiben, wenn die Funktion einen Wert zurückgibt Sie so etwas wie

@return array $someArray An array of formatted dates

schreiben würde Aber lassen Sie uns sagen, dass meine Funktion keinen Wert zurückgibt, sondern ändert es das Original Wert, der als Referenz etwa wie folgt übergeben wird:

function formatDates(&$input_arr){ 
     /** 
     * Formats an array of dates 
     * @param array $input_arr An array of raw dates 
     */ 
     array_walk_recursive($input_arr, 'formatDateFunction'); 
    } 

Diese Funktion ändert das Eingabearray.

Ich weiß, es ist offensichtlich mit der & vor dem Parameter, aber Rückgabewerte sind ziemlich offensichtlich mit return vor ihnen auch, also habe ich das Gefühl, dass es einen Standard dafür geben kann?

Derzeit Ich erwähne es nur in der Funktionsbeschreibung wie:

 /** 
     * Formats an array of dates, modifies original array 

Gibt es eine häufig verwendete Art und Weise der besagt, dass eine Funktion, um den Eingangswert in der PHP-Dokumentation ändert? Oder ist es nur normalerweise wie angedeutet?

Answer 1

Wie so

* @param array &$array modified parameter array of dates