Загальні положення 4 Частина Основи мови С++ 9

Система документування вихідного коду Doxygen
Нижче наводяться стислі рекомендації з використання пакета Doxygen спільно з Microsoft Visual Studio в ОС Windows для документування проектів на мові C++.
Doxygen – програмний комплекс, призначений для аналізу вихідного тексту програм і автоматичного створення документації на основі коментарів. Підтримуються мови: C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#, частково D (вікі: http://ru.wikipedia.org/wiki/Doxygen; сайт проекту: http://www.stack.nl/~dimitri/ doxygen).
Ознайомлення із засобами автоматичного документування розроблюваних проектів на мові C++ в середовищі Visual Studio за допомогою пакету Doxygen дає можливість значно спростити і прискорити процес створення супровідної документації.
Передбачається доступність та наявність наступних програмних засобів:

• 
  пакет Microsoft Visual Studio – заздалегідь встановлений і налаштований для розробки проектів на мові C++;
  
• 
  пакет Doxygen – установка, настройка і використання розгля-даються нижче; для повноцінної роботи пакета необхідно встановити наступні додаткові програмні засоби:
  

• 
  Graphviz – пакет утиліт для автоматичної візуалізації графів, заданих у вигляді опису на мові dot (сайт проекту: http://www.graphviz.org/);
  
• 
  Mscgen – програмний засіб для побудови діаграм послідовності (в UML – діаграми взаємодії об’єктів, впорядковані за часом їх прояву; сайт проекту: http://www.mcternan.me.uk/mscgen).
  

Встановлення програмного забезпечення
Рекомендовані шляхи для установки пакетів Doxygen, Graphviz і Mscgen відповідно:
c:\Program Files\doxygen\
c:\Program Files\doxygen\graphviz\
c:\Program Files\doxygen\mscgen\
Налаштування Visual Studio для використання Doxygen
Для зручного використання Doxygen безпосередньо в середовищі Visual Studio необхідно створити найпростіший проект Visual C++ і виконати наступні дії (рис. 11.1):

1. 
   В основному меню вибрати пункт «Tools\External Tools».
   
2. 
   За допомогою кнопки «Add» додати пункт «doxyWizard» з наступними параметрами:
   

• 
  Title: doxyWi&zard;
  
• 
  Command: C:\Program Files\doxygen\bin\doxywizard.exe;
  
• 
  Arguments: $(ProjectDir)doxy;
  
• 
  Initial directory: $(ProjectDir).
  

Рисунок 11.1 – Вікно налаштувань Visual Studio для використання Doxygen

3. 
   Натиснувши кнопку «Ok», зберегти зміни.
   

У результаті такого налаштування майстер пакета Doxygen для обробки файлів поточної директорії проекту може бути використаний по команді меню «Tools\doxyWizard» або за допомогою комбінації клавіш «Alt+T, Z».