Выходные параметры phpDocumentor - PullRequest
       25

Выходные параметры phpDocumentor

2 голосов
/ 15 февраля 2012

У меня есть блок кода, который был написан некоторое время назад, и я просматриваю документ, но у одной из функций есть выходной параметр - как должен быть написан phpDoc-блок, чтобы указать, что параметр являетсяВыходной параметр?

Примечание. Это не «Я люблю выходные параметры» или «Я хочу их использовать», а «Они использовались, как они документированы?»: P

На всякий случай, если я неправильно их назвал, примерно так:

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

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

1 Ответ

3 голосов
/ 15 февраля 2012

Я бы использовал:

@param    integer    &$bar    value to be reset

с & в блоке параметров

...