是否有 PHPDoc 标准来描述通过引用传递的函数属性？

Question

我有一个函数使用作为引用传递的属性：

public function doSomething(&$argumentPassedByReference)
{
    // ...
}

我维护我项目的 PHPDoc，所以我这样描述我的功能：

/**
 * Do something very useful with the thing passed in parameters
 *
 * @param Type $argumentPassedByReference Thing that will be edited
 */
public function doSomething(&$argumentPassedByReference)

但我不是很满意，因为它没有显示 $argumentPassedByReference 是通过引用传递的。 PHPDoc 中是否有一个标准来描述这个？

Answer 1

在函数定义中添加 & 符号：

 /**
 * Do something very useful with the thing passed in parameters
 *
 * @param Type &$argumentPassedByReference Thing that will be edited
 */

Answer 2

Psalm 有 @param-out 用于标记输出类型 - 不完全相同但可能有用。

是否有 PHPDoc 标准来描述通过引用传递的函数属性？

Is there a PHPDoc standard to describe function attributes passed by reference?

php

phpdoc