2010-10-18 60 views
1

我正在實施基於我們的應用程序使用Symfony Event Dispatcher的事件分派系統的過程。管理員可以啓用或啓用一系列模塊,中央註冊中心將自動註冊插件感興趣的事件並處理事件分派。PHPDoc自定義部分和分組

我們目前使用PHPDoc來生成我們所有的文檔,並且有嚴格的PHP Codesniffer標準,以確保文檔的完整性和一致性。

我想要做的是自動生成文檔,在一個地方列出所有系統中可用的事件;我想通過使查找哪些事件可用,哪些數據在這些事件中提供以及哪些響應可以隨事件發送而容易地開發新的插件。

有什麼辦法可以實現這個使用PHPDoc?到目前爲止,我所擁有的最佳方法是向通知事件的方法添加@uses標記,並引用我的PluginRegistry類;這種方式至少可以找到相關的方法,但是它遠不夠理想,因爲它沒有提供額外的文檔(什麼事件可用,什麼數據,什麼返回數據,甚至方法中有多少事件)。

回答

1

讓所有的事件都實現一個特定的接口,然後你可以使用你生成的phpdoc文件找出哪些類實現了該事件接口。

+0

爲了操作文檔而添加一堆類似乎有些不正確,我的事件只是sfEvents(sfEvent類的實例),因爲它們不會爲標準添加新的行爲或狀態。你說的是對的,但是我認爲這是正確的方式。 – 2010-10-18 21:11:09