如何为瘦框架路由/回调生成phpdoc - How do I generate a phpdoc for slim framework routes / callbacks

How do I generate a phpdoc for slim framework routes / callbacks

本文关键字：回调 phpdoc 路由框架 | 更新日期: 2023-09-27

我正在努力弄清楚如何构建代码，以便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上不可用。。。那么它甚至需要被记录下来吗？