1

我正在使用Symfony Event Dispatcher在我们的应用程序中实现一个事件调度系统。管理员可以启用或启用一系列模块,中央注册表将自动注册插件感兴趣的事件并处理事件的调度。

我们目前使用 PHPDoc 来生成我们所有的文档,并有一个严格的 PHP Codesniffer 标准来确保文档的完整性和一致性。

我想要做的是自动生成文档,在一个地方列出系统中可用的所有事件;我想通过轻松找出可用的事件、这些事件中提供的数据以及可以随事件发送的响应来轻松开发新插件。

有没有办法使用 PHPDoc 来实现这一点?到目前为止,我最好的方法是在通知事件的方法中添加一个 @uses 标签,引用我的 PluginRegistry 类;这样至少可以找到相关的方法,但它远远不够理想,因为它没有提供额外的文档(什么事件可用,什么数据,什么返回数据,甚至方法中有多少事件)。

4

1 回答 1

1

让你所有的事件实现一个特定的接口,然后你可以使用你生成的 phpdoc 文件来找出哪些类实现了那个事件接口。

于 2010-10-18T08:31:07.627 回答