php - PHPDoc中的闭包语法

我在PHPDoc中找不到有关Closure类型的任何文档。所以我的问题是如何定义发送到闭包的参数及其返回值的参数？

例子:

我如何描述“回调”将获得“MyCustomClass”，数字和字符串，并返回“MyOtherCustomClass”？

/**
 * @param MyCustomClass $cls
 * @param Closure       $callback this isn't really explaining what this is
 *
 * @return MyOtherCustomClass
 */
function changer($cls, $callback){

  return $callback($cls, 2, "a string");
}

changer($aCustomeClass, function($cls, $int, $string){
   return new MyOtherCustomClass($cls, $int, $string);
})

还是完全有可能？

最佳答案

@param callable $callback确实是用于该部分的语法。您并没有将参数限制为闭包本身……传递给它的任何可调用都会在该实现中被接受。 Callable是合法的“PHP类型”，因此phpDocumentor接受它为有效类型。

在示例代码中，实际上没有理由假定changer()方法返回MyOtherCustomClass()，因为这完全是由您稍后在changer()用法中编写闭包所决定的。充其量，您需要在changer()用法的注释中表示，这种changer()的特殊用法返回MyOtherCustomClass，因为返回的是特定类型的对象是用法的实现，而不是changer()实现本身。

至于记录传递的Callable必须“接受”的参数，我想您必须在param标记的描述部分中执行此操作。没有语法来描述这种情况。

如果我要以这种方式实现某些东西，我会强加一个所有可调用对象都必须显式返回的接口(interface)，这样我就可以写成changer()返回该接口(interface)。当然，这意味着您的MyOtherCustomClass必须实现该接口(interface)，但是，对我来说，这似乎是接近于“强制” changer()的返回类型的唯一方法。

关于php - PHPDoc中的闭包语法，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/16589902/