phpDocumentor 输出参数

发布于 2025-01-05 09:39:04 字数 305 浏览 1 评论 0原文

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

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

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

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

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

I've got a block of code which was written a while ago and I'm looking to document, but one of the functions has an output parameter - how should a phpDoc-block be written to specify that a parameter is an output parameter?

Note - this isn't "I love output parameters" or "I want to use them", it's "They were used, how are they documented?" :P

Just in case I've got the name of them wrong, something like this:

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

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

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

瀟灑尐姊 2025-01-12 09:39:04

我会使用:

@param    integer    &$bar    value to be reset

与 &在参数块中

I'd use:

@param    integer    &$bar    value to be reset

with the & in the param block

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文