如何为slim框架路由/回调生成phpdoc

如何为slim框架路由/回调生成phpdoc,php,phpdoc,slim,Php,Phpdoc,Slim,我正在努力找出如何构造代码,以便phpDocumentor能够利用代码块 /** * GET -- Book, either filtered by id or a full list. * * @param SlimApplication $app The application object instance. * @param integer $id The id of the book */ $callbackFunction =

我正在努力找出如何构造代码,以便phpDocumentor能够利用代码块

/**
 * GET -- Book, either filtered by id or a full list.
 *
 * @param   SlimApplication     $app    The application object instance.
 * @param   integer             $id The id of the book
 */
$callbackFunction = function($id) use ($app)
{
    //some functionality here.
};
$app->get('/books(/:id)', $callbackFunction );
我可能应该继续使用内联
use
语句,这样我就可以使用
$app


有人有什么建议吗?

phpDocumentor没有特殊的语法来记录这样的匿名函数。如果你想记录闭包本身,你需要将它定义为一个第一类函数,然后你可以这样记录它


如果知道闭包存在并且文档读者需要知道它的详细信息,那么它可能足够重要,可以成为第一类函数吗?然后,作为一个闭包,它实际上在代码的API上不可用。。。那么它甚至需要被记录吗?

好吧,目标是生成一个自动生成的API文档。但是,您希望文档告诉读者关于匿名函数的什么内容呢?示例docblock意味着您希望文档将闭包显示为一级函数,以便读者能够了解其参数要求。然而,读者实际上无法编写任何代码来调用该闭包,因此它只是“代码内部”信息。我想我的主要观点是,我不明白为什么代码文档的读者需要知道这个闭包或者它是如何工作的。我能想象的最接近的用例是通过链接查看源代码的编码器阅读器。