Как использовать doxygen для создания диаграмм классов UML из исходного кода C++

Doxygen создает диаграммы наследования, но я не думаю, что он создаст целую иерархию классов. Это позволяет вам использовать инструмент GraphViz. Если вы используете интерфейсный инструмент Doxygen с графическим интерфейсом, вы найдете соответствующие параметры в Step2: -> Wizard tab -> Diagrams. Параметры отношения DOT находятся на вкладке «Эксперт».

Хм, кажется, это немного старый вопрос, но, поскольку последние несколько дней я возился с конфигурацией Doxygen, пока моя голова все еще полна текущей информации, давайте попробуем -

Я думаю, что предыдущие ответы почти имеют это:

Отсутствующий вариант — добавить COLLABORATION_GRAPH = YES в Doxyfile. Я предполагаю, что вы можете сделать эквивалентную вещь где-нибудь в графическом интерфейсе doxywizard (я не использую doxywizard).

Итак, в качестве более полного примера, типичные параметры «Doxyfile», связанные с выводом UML, которые я обычно использую:

EXTRACT_ALL          = YES
CLASS_DIAGRAMS      = YES
HIDE_UNDOC_RELATIONS = NO
HAVE_DOT             = YES
CLASS_GRAPH          = YES
COLLABORATION_GRAPH  = YES
UML_LOOK             = YES
UML_LIMIT_NUM_FIELDS = 50
TEMPLATE_RELATIONS   = YES
DOT_GRAPH_MAX_NODES  = 100
MAX_DOT_GRAPH_DEPTH  = 0
DOT_TRANSPARENT      = YES

Эти настройки будут генерировать диаграммы «наследования» (CLASS_GRAPH=YES) и «сотрудничества» (COLLABORATION_GRAPH=YES).

В зависимости от вашей цели для «развертывания» вывода doxygen, настройка DOT_IMAGE_FORMAT = svg также может быть полезна. С выводом svg диаграммы являются «масштабируемыми» вместо фиксированного разрешения растровых форматов, таких как .png. По-видимому, при просмотре вывода в браузерах, отличных от IE, также есть INTERACTIVE_SVG = YES, который позволит «интерактивное масштабирование и панорамирование» сгенерированных диаграмм svg. Я попробовал это некоторое время назад, и вывод svg был очень визуально привлекательным, но в то время браузерная поддержка svg все еще была немного непоследовательной, поэтому, надеюсь, в последнее время ситуация улучшилась.

Как упоминалось в других комментариях, некоторые из этих настроек (в частности, DOT_GRAPH_MAX_NODES) потенциально могут повлиять на производительность, поэтому YMMV.

Я склонен ненавидеть ответы в стиле «RTFM», поэтому прошу прощения за это предложение, но в этом случае документация Doxygen действительно ваш друг, поэтому ознакомьтесь с документацией Doxygen по вышеупомянутым настройкам — в последний раз, когда я смотрел, вы можете найти подробности на http://www.doxygen.nl/manual/config.html.

Цитата из этот пост (он написан самим автором doxygen):

run doxygen -g and change the following options of the generated Doxyfile:

    EXTRACT_ALL            = YES
    HAVE_DOT               = YES
    UML_LOOK               = YES

run doxygen again

Enterprise Architect построит диаграмму UML из импортированного исходного кода.

Я думаю, вам нужно будет отредактировать файл doxys и установить для GENERATE_UML (что-то вроде этого) значение true. И вам нужно установить dot/graphviz.

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

Некоторые важные примечания:

• Doxygen не будет генерировать фактическую полную диаграмму всех классов в проекте. Для каждой иерархии будет создано отдельное изображение. Если у вас есть несколько несвязанных иерархий классов, вы получите несколько изображений.
• Все эти схемы можно найти в html/inherits.html или (из навигации по сайту) классы => иерархия классов => "Перейти к текстовой иерархии классов".
• This is a C++ question, so let's talk about templates. Especially if you inherit from T.
  • Each template instantiation will be correctly considered a different type by Doxygen. Types which inherit from different instantations will have different parent classes on the diagram.
  • Если шаблон класса foo наследуется от T и параметр типа шаблона T имеет значение по умолчанию, такое значение будет принято. Если существует тип bar, который наследуется от foo<U>, где U отличается от значения по умолчанию, bar будет иметь родителя foo<U>. foo<> и bar<U> не будут иметь общего родителя.
  • Если существует несколько шаблонов классов, которые наследуют хотя бы один из параметров своего шаблона, Doxygen будет предполагать общего родителя для этих шаблонов классов, если параметры типа шаблона имеют точно такие же имена в коде. Это стимулирует последовательность в именовании.
  • CRTP и обратный CRTP просто работают.
  • Рекурсивные деревья наследования шаблонов не раскрываются. Будет показано, что любой экземпляр variant наследуется от variant<Ts...>.
  • Рисуются шаблоны классов без инстанций. В их имени будет строка <...>, представляющая тип и нетиповые параметры, для которых не было значений по умолчанию.
  • Также отрисовываются шаблоны классов полной и частичной специализаций. Doxygen генерирует правильные графы, если специализации наследуются от разных типов.