phpDocumentor 输出参数

Question

我有一段前段时间写的代码块，我正在寻找文档，但是其中一个函数有一个输出参数 - 应该如何编写一个 phpDoc block 来指定一个参数是一个输出参数？

注意 - 这不是“我喜欢输出参数”或“我想使用它们”，而是“它们被使用了，它们是如何记录的？” :P

以防万一我把它们的名字弄错了，像这样:

function foo (&$bar)
{
    $bar = 1;
    return 2;
}

$varIs2 = foo($varIs1);
echo $varIs1; // 1
echo $varIs2; // 2

Answer 1

我会使用:

@param    integer    &$bar    value to be reset

在 param block 中使用 &