"function modifies argument passed by reference" 是否有 PHP 文档语法？

Question

在为函数编写 PHP 文档时，如果函数 return 是一个值，您将编写类似

的内容

@return array $someArray An array of formatted dates

但是假设我的函数没有 return 值，而是修改作为参考传递的原始值，例如：

   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 值前面的 return 也很明显，所以我觉得可能有这个有标准吗？

目前，我只是在功能描述中提到它：

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

在 PHP 文档中是否有一种常用的方式来说明函数修改输入值？或者它通常只是隐含的？

Answer 1

喜欢

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

"function modifies argument passed by reference" 是否有 PHP 文档语法？

Is there a PHP Doc syntax for "function modifies argument passed by reference"?

php

documentation