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

Використання Doxygen у середовищі Visual Studio
Нижче приводиться послідовність дій для використання Doxygen у середовищі Visual Studio.

1. 
   Створити проект Visual C++.
   
2. 
   Підготувати й зберегти вихідний код у файлах «.cpp» і «.h». При підготовці вихідного коду використовувати спеціальний вид коментарів (див. нижче).
   
3. 
   Виконати обробку файлів з вихідним кодом пакетом Doxygen:
   

• 
  викликати майстер Doxywizard – меню «Tools\doxywizard» або клавіші Alt+T, Z;
  
• 
  активувати Doxygen – закладка «Run», кнопка «Run doxygen»;
  
• 
  дочекатися повідомлення «Doxygen has finished» у вікні «Output produces by doxygen».
  

4. 
   Перевірити результат – кнопка «Show HTML output». Результат роботи Doxygen зберігається в папці html поточного каталогу проекту (використовувати файл «index.html»).
   

Рекомендації до коментування вихідного коду
Коментарі приводяться безпосередньо перед уведенням імен – оголошенням класів, їх полів, методів, а так само функцій, змінних, констант і т.д.
Коментарі в Javadoc стилі:

/**
* Короткий коментар.

* Докладний опис
*/

Можна приводити коментарі в тому ж рядку, що й коментований вираз:

int var; /**< Текст коментаря */
або
int var; ///< Текст коментаря

Кожний файл проекту починається із заголовка:

/**
* @file Filename.ext Призначення даного файлу

* @author ім’я
* @version х.х
* @date хххх.хх.хх
*/
Приклад коментарів для класу (файл Base.h):

/**
* Короткий опис класу.

* Докладний опис класу
*/
class Cbase {

protected:

int ix; ///< Опис поля

public:

/**
* Короткий опис конструктора.
* Докладний опис конструктора
*/
Cbase() : ix(1) {}

/// Короткий опис деструктора

virtual ~cbase() {}
};

Приклад коментарів для перевантаженого оператора при його оголошенні:

/**
* Виводить екземпляри Base і його нащадків у стандартний потік.

* Для виводу в потік використовується віртуальний метод,
* що викликається через посилання на базовий клас (поліморфізм)
* @param o Посилання на потік виводу
* @param x Посилання на виведений об’єкт
* @return Посилання на потік виводу
* @remark Приклад перевантаження оператора для базового класу,
* який використовується й для його нащадків
* @see Base
*/
ostream & operator << (ostream &o, Base &x);

Можливі варіанти коментування вихідного коду, що обробляється системою Doxygen, докладно розглянуті в прикладеній до пакета документації (див. файл C:\Program Files\doxygen\html\docblocks.html).