PHP Doxygen Collaboration Diagrams - PullRequest
       8

PHP Doxygen Collaboration Diagrams

3 голосов
/ 19 ноября 2010

Я начал играть с doxygen, чтобы генерировать документацию из моего PHP-кода. Я заметил, что в сгенерированном выводе есть две диаграммы - наследование и совместная работа. Я знаю о наследовании, но сотрудничество вызвало у меня интерес после прочтения руководства:

Если для тегов COLLABORATION_GRAPH и HAVE_DOT установлено значение YES, тогда doxygen сгенерирует график для каждого документированного класса, показывающий прямой и косвенные зависимости реализации (наследование, сдерживание и переменные ссылки на класс) класса с другими документированными классами.

Из этого описания складывается впечатление, что композиционные отношения также должны быть представлены диаграммой сотрудничества, но она всегда кажется идентичной наследственной.

Есть ли что-то, что я могу сделать, чтобы подсказать Doxygen, что я хотел бы показать на этой диаграмме? Разве это не работает с PHP?

Ответы [ 3 ]

2 голосов
/ 25 декабря 2010

Может ли это быть из-за того, что классы, для которых вы его используете, мало что показывают на диаграмме сотрудничества, КРОМЕ наследования?

Пробовали ли вы это на составных классах?(классы, содержащие объекты-члены других классов)

В этих случаях (по крайней мере, в C ++) он генерировал сложные диаграммы с цветовой кодировкой, представляющие различные отношения.

0 голосов
/ 09 декабря 2010
0 голосов
/ 07 декабря 2010

Я никогда не пытался генерировать диаграммы сотрудничества с doxygen, но я считаю, что вы должны документировать свой код следующим образом:

class B {}

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

Если вы опустите докблок, доксиген может не распознать, что $ b относится к типу B, и, следовательно, не будет включать B в диаграмму сотрудничества.

...