phpDocumentor 输出参数
我有一段不久前编写的代码块,我正在寻找文档,但其中一个函数有一个输出参数 - 应该如何编写 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 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
我会使用:
与 &在参数块中
I'd use:
with the & in the param block