documentation - 如何使用 phpdocumentor 记录闭包？

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<-->@usedby 文档链接到你的闭包正在使用的 Silex\Application->escape() 方法？

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