phpDocumentor输出参数

时间:2012-02-15 15:40:21

标签: php documentation phpdoc output-parameter

我有一段代码已经写了一段时间,我正在寻找文档,但其中一个函数有一个输出参数 - 如何编写phpDoc-block来指定参数是一个输出参数?

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

以防万一我的名字错了,就像这样:

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

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

1 个答案:

答案 0 :(得分:3)

我会用:

@param    integer    &$bar    value to be reset

与&在param块中