Библиотека C/C++ разработчика | cpp, boost, qt

🍪 Doxygen

❗️Проблема:

Поддержка актуальной документации для C++ проектов требует постоянного обновления отдельных файлов. Разработчики забывают обновлять документацию после изменения кода, что приводит к устаревшей и неточной информации.


✅ Решение:

Doxygen автоматически генерирует документацию из специальных комментариев в коде. Инструмент создает HTML, PDF и другие форматы документации с диаграммами классов и зависимостей.


✏️ Пример кода:

/**
 * @brief Класс для работы с геометрическими фигурами
 * @author Имя разработчика
 * @date 2024-01-15
 */
class Shape {
protected:
    double width;  ///< Ширина фигуры
    double height; ///< Высота фигуры
    
public:
    /**
     * @brief Конструктор с параметрами
     * @param w Ширина фигуры (должна быть > 0)
     * @param h Высота фигуры (должна быть > 0)
     * @throw std::invalid_argument при некорректных параметрах
     */
    Shape(double w, double h) : width(w), height(h) {
        if (w <= 0 || h <= 0) {
            throw std::invalid_argument("Размеры должны быть положительными");
        }
    }
    
    /**
     * @brief Вычисляет площадь фигуры
     * @return Площадь в квадратных единицах
     * @note Виртуальный метод, должен быть переопределен
     */
    virtual double calculateArea() const = 0;
    
    /// Деструктор по умолчанию
    virtual ~Shape() = default;
};

# Генерация документации
doxygen -g  # Создание конфигурационного файла
doxygen Doxyfile  # Генерация документации

✅ Преимущества:

— Автоматическая генерация документации из кода
— Поддержка множества выходных форматов
— Создание диаграмм классов и зависимостей
— Синхронизация документации с кодом


🐥 А как вы пишите документацию? Пишите в комментариях.


🐸Библиотека C/C++ разработчика #буст

Please open Telegram to view this post

VIEW IN TELEGRAM

🔥5👍3❤1🥰1

www.tgoop.com/cppproglib/5862

1.92K viewsedited  Jul 8 at 11:46

🍪 Doxygen

❗️Проблема:

Поддержка актуальной документации для C++ проектов требует постоянного обновления отдельных файлов. Разработчики забывают обновлять документацию после изменения кода, что приводит к устаревшей и неточной информации.


✅ Решение:

Doxygen автоматически генерирует документацию из специальных комментариев в коде. Инструмент создает HTML, PDF и другие форматы документации с диаграммами классов и зависимостей.


✏️ Пример кода:

/**
 * @brief Класс для работы с геометрическими фигурами
 * @author Имя разработчика
 * @date 2024-01-15
 */
class Shape {
protected:
    double width;  ///< Ширина фигуры
    double height; ///< Высота фигуры
    
public:
    /**
     * @brief Конструктор с параметрами
     * @param w Ширина фигуры (должна быть > 0)
     * @param h Высота фигуры (должна быть > 0)
     * @throw std::invalid_argument при некорректных параметрах
     */
    Shape(double w, double h) : width(w), height(h) {
        if (w <= 0 || h <= 0) {
            throw std::invalid_argument("Размеры должны быть положительными");
        }
    }
    
    /**
     * @brief Вычисляет площадь фигуры
     * @return Площадь в квадратных единицах
     * @note Виртуальный метод, должен быть переопределен
     */
    virtual double calculateArea() const = 0;
    
    /// Деструктор по умолчанию
    virtual ~Shape() = default;
};

# Генерация документации
doxygen -g  # Создание конфигурационного файла
doxygen Doxyfile  # Генерация документации