PHPDoc自定义部分和分组

时间:2010-10-18 00:46:21

标签: php phpdoc

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

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

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

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

1 个答案:

答案 0 :(得分:1)

让您的所有事件都实现特定的接口,然后您可以使用生成的phpdoc文件找出实现该事件接口的类。