如何为苗条的框架路由/回调生成 phpdoc

【问题标题】：How do I generate a phpdoc for slim framework routes / callbacks如何为苗条的框架路由/回调生成 phpdoc
【发布时间】：2013-08-19 22:31:18
【问题描述】：

我正在努力弄清楚如何构建我的代码，以便 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。

大家有什么建议吗？

【问题讨论】：

标签： php phpdoc slim

【解决方案1】：

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

如果知道闭包存在并且文档阅读者需要知道它的细节，那么作为一等函数可能就足够重要了？话又说回来，作为一个闭包，它实际上在代码的 API 上不可用......所以它甚至需要记录吗？

【讨论】：

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