Question

所以，我正在使用Silex微框架，我很好奇PHPDoc正确的文档闭包方式。

require_once __DIR__.'/silex.phar'; 

$app = new Silex\Application(); 

$app->get('/hello/{name}', function($name) use($app) { 
    return 'Hello '.$app->escape($name); 
}); 

$app->run();

我如何记录GET关闭？

Answer 1

关于该关闭，您想对文档的读者说些什么？是否要突出显示它存在，或者创建一个@ uses＆lt; - ＆gt; @usedby文档链接到您的闭包使用的Silex \ Application-＆gt; escape（）方法？

我不知道存在任何PHPDoc语法来记录闭包（但是），但鉴于它在API上下文中实际上不能被消费者使用，我不确定是否有用例来记录它......除了向代码阅读文档阅读器提供细节之外。如果是后者，我可能会使用@internal标签来编写关于闭包的任何注释，我希望读者能够注意到。此外，鉴于我在该代码段中没有看到“可记录元素”，您必须将@internal标记放在文件级docblock中。

如何使用phpdocumentor记录闭包？

1 个答案: