是否有适用于"function modifies argument passed by reference"的 PHP 文档语法?



在为函数编写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文档中的输入值?还是说它通常只是隐含的

类似

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

相关内容

  • 没有找到相关文章

最新更新