PHP Doxygen Collaboration Diagrams

时间:2010-11-19 06:51:24

标签: php documentation doxygen

我开始使用doxygen来生成PHP代码的文档。我注意到生成的输出中有两个图表 - 继承和协作。我知道继承之一,但是自从阅读手册以来,我的兴趣引起了我的兴趣:

  

如果COLLABORATION_GRAPH和HAVE_DOT标记设置为YES,则doxygen   将为每个记录的类生成一个图表,显示直接和   间接实现依赖(继承,包含和   具有其他记录类的类的类引用变量。

我从该描述得到的印象是组合关系也应该由协作图表示,但它似乎总是与继承关系相同。

我能做些什么来提示Doxygen我想在这个图中出现的东西吗?它不适用于PHP吗?

3 个答案:

答案 0 :(得分:2)

可能是因为您使用它的类在协作图中没有太多要显示的EXCEPT继承吗?

你有没有尝试过复合类? (包含其他类的成员对象的类)

在这些情况下,(至少使用C ++),它生成了代表各种关系的复杂颜色编码图。

答案 1 :(得分:0)

我从未尝试使用doxygen生成协作图,但我相信你必须像这样记录你的代码:

class B {}

class A {
    /**
     * @var B
     */
    private $b;
}

如果省略docblock,doxygen可能无法识别$ b是B类型,因此不会在协作图中包含B.

答案 2 :(得分:0)