auto-docs-astu

Генерация отчётов и таблиц для дисциплины «Программирование и информатика»

Установка

Способов два:

1. Скачать из репозитория auto-docs-astu.exe
2. Запустить самому из исходника, но потребуется библиотека python-docx:

pip install python-docx

Подготовка исходника для генерации таблицы функций

Для правильной генерации таблицы с описанием функций, достаточно написать комментарий с описанием прямо над функцией. Несмотря на то, что синтаксически необходимо использовать многострочный комментарий (/* ... */), программа будет работать верно, только если комментарий написан в одну строку. Следующая за комментарием строка считается заголовком функции и вносится в таблицу.

Пример:

/*func Добавляет новый элемент в список */
void push(List &list, float value)
{
    list.top = new Node(value, list.top);
}

Результат:

Подготовка исходника для генерации таблицы классов

Для правильной генерации таблицы с описанием класса, необходимо указать поля класса (однострочный комментарий справа от объявления переменной, начинающийся с //f ) и его методы (многострочный комментарий над методом, начинающийся с /*m ).

Пример:

class Student 
{
    private:
        int id;  //f Личный идентификатор студента
        std::string name;  //f Имя студента
    public:
        /*m Инициализация экземпляра класса Студент*/
        void init(int i, std::string n)
        {
             id = i;
             name = n;
        }

        /*m Вывод информации о студенте в консоль*/
        void display()
        {
             std::cout << id << "  " << name << std::endl;
        }
};

Результат:

Использование

При первом запуске будет создан файл config.ini (если Вы его не скачали сразу). Пример заполнения:

[Параметры]
номер лабы = 6
номер варианта = 9
автор = Иванов И.И.
преподаватель - Иванова.И.И.
имя исходника = lab6.cpp

Заполнение полей "номер лабы" и "номер варианта" не обязательно. Если оставить их пустыми, шапка отчёта сгенерирована не будет, будут сгенерированы только таблицы на основе исходного кода.

Файл с исходным кодом (в примере - lab6.cpp, (любой текстовый формат, главное чтобы комментарии в коде были верно написаны)) должен находиться в директории с программой. Если config.ini уже существует, будет сгенерирован docx документ с названием исходника (в примере - lab6.docx).