php - "function modifies argument passed by reference"是否有 PHP Doc 语法？

Question

在为函数编写 PHP 文档时，如果函数返回一个值，您将编写如下内容

@return array $someArray 格式化日期数组

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

   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 修饰日期参数数组