是否有“函数修改参数传递的参数”的PHP Doc语法？

Question

在为函数编写PHP文档时，如果函数返回一个值，你会写一些类似的东西

@return array $someArray An array of formatted dates

但是，假设我的函数没有返回值，而是修改了作为引用传递的原始值，例如：

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

此函数修改输入数组。

我知道参数前面的&很明显，但返回值非常明显，在它们前面也有return ，所以我觉得可能有一个标准吗？

目前，我只是在函数描述中提到它：

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

是否有一种常用的方法来声明函数修改PHP文档中的输入值？ 或者它通常只是暗示？

Answer 1

像这样

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