PHPDoc:使用可变数量的参数记录函数
PHPDoc:使用可变数量的参数记录函数
提问于 2013-01-25 08:27:42
记录接受可变数量参数的类方法时，推荐的方法是什么？
也许是这样的？
<?php
class Foo {
/**
* Calculates the sum of all the arguments.
*
* @param mixed [$arg1, $arg2, ...]
*
* @return float the calculated sum
*/
public static function sum() {
return array_sum(func_get_args());
}
}注意:一般来说，我认为在可能的情况下应该避免这种类型的事情。话虽如此，如果仍然记录下剩下的几个无法避免的案例，那就更好了。
回答 3
Stack Overflow用户
发布于 2016-07-09 06:03:27
如果您使用可变数量的参数，并且还使用PHP >= 5.6，那么您可以使用可变函数(允许可变数量的参数)，它仍然符合前面提到的PHPDoc ,...语法，并且PHPStorm也可以正确地解释文档。使用可变函数消除了将参数捕获到数组中所需的func_get_args()。
/**
* @param mixed $args,... Explainatorium!
*/
function variadiculous(...$args) {
// NOTE: $args === func_get_args()
foreach ( $args as $arg ) {
/* do work */
}
}PHPStorm会将文档自动生成为@param array $args，因为从技术上讲，在函数内部，variadiculous is_array($args)是真的。我将其更改为如上所述地读取@param mixed $args,...，并且当我在代码中使用热键显示来自其他地方的函数签名时，PHPStorm将显示variadiculous($args : ...array|mixed) --如果您使用的是PHP5.6，我建议使用这种方法
Stack Overflow用户
发布于 2013-01-25 08:48:16
/**
* @param mixed $numbers,... Description
*/
Public function sum ($numbers)在该方法中，将不使用$numbers。
Stack Overflow用户
发布于 2017-04-26 07:31:02
在... syntax的情况下，PHPStorm 2017.1使用：
/**
* @param Type[] ...$values One or more values.
*/
public function func(Type ...$values) {
// ...
}页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/14513356
复制相关文章
相似问题