Содержание
Введение 3
1. Создание документации из исходных кодов 5
1.1. Автодокументирование с помощью Doxygen 5
1.2. Способы использования Doxygen 7
2. Возможности документирования в системе Doxygen 8
2.1. Многострочный блок 9
2.2. Однострочный блок 10
2.3. Помещение документации после переменных 11
2.4. Документирование в различных местах 12
3. Практическое применение Doxygen 14
Заключение 15
Список литературы 16
Выдержка из текста
Компьютерные и информационные технологии проникают во все сферы жизнедеятельности человека. Вычислительные мощности компьютеров с каждым годом растут, как растёт и объём информации, который необходимо чётко систематизировать и хранить, вести по ней учёт данных. Именно этот факт делает использование вычислительных машин незаменимым на производствах различного типа, в областях экономики и культуры. Компьютеры помогают автоматизировать производственные процессы, процессы обработки больших объёмов информации, её хранение.
Написание документации к коду задача не самая простая и уж точно не самая приятная, но к счастью существуют инструменты которые могут существенно упростить эту процедуру.
Вероятнее всего, каждый из нас сталкивался с результатами работы различных генераторов документации. Общий принцип их работы следующий: на вход такого генератора поступает специальным образом комментированный исходный код, а иногда и другие компоненты программы, а на выходе создаётся готовая документация для распространения и использования.
Рассматриваемая система Doxygen как раз и выполняет эту задачу: она позволяет генерировать на основе исходного кода, содержащего комментарии специального вида, красивую и удобную документацию, содержащую в себе ссылки, диаграммы классов, вызовов и т.п. в различных форматах: HTML, LaTeX, CHM, RTF, PostScript, PDF, man-страницы.
Doxygen генерирует документацию на основе набора исходных текстов и также может быть настроен для извлечения структуры программы из недокументированных исходных кодов. Возможно составление графов зависимостей программных объектов, диаграмм классов и исходных кодов с гиперссылками
В большинстве примеров Doxygen используется для документации программного обеспечения, написанного на языке C++, однако на самом деле данная система поддерживает гораздо большое число других языков: C, Objective-C, C#, PHP, Java, Python, IDL, Fortran, VHDL, Tcl, и частично D.
Список использованной литературы
1. Хорошевский В.Г. Архитектура вычислительных систем. – М.: МГТУ им. Н.Э. Баумана, 2011. — 520 с.
2. Евреинов Э.В., Хорошевский В.Г. Однородные вычислительные системы. – Новосибирск : Наука. Сибирское отд-е, 2012. – 319 с.
3. Ахо А., Хопкрофт Дж., Ульман Дж. Структуры данных и алгоритмы. — М.: Издательский дом “Вильямс”, 2010. — 384 с.
4. Кормен Т., Лейзерсон Ч., Штайн К. Алгоритмы: построение и анализ, 2-е издание. : Пер. с англ. – М.: Издательский дом “Вильямс”, 2014. — 452 с.
5. Седжвик Р. Фундаментальные алгоритмы на C++. — М.: ДиаСофт, 2011. — 688 с.
6. Могилев А.В., Пак Н.И., Хённер Е.К. Информатика. 2-е изд. Учеб. пособие. — М: Изд. центр Академия, 2003. — 816 с.
7. Иванова Г. Е., Ничушкина Т. Н. Объектно-ориентированное программирование. Учебник. — М: МГТУ им. Н. Э. Баумана, 2014. — 456 с.
8. Генри С. Уоррен Мл. Алгоритмические трюки для программистов, 2-е издание. М., 2014.
9. Интеренет, сайт http://www.devexp.ru/2010/02/ispolzovanie-doxygen-dlya-dokumentirovaniya-koda/
10. Интеренет, сайт https://packages.debian.org/ru/sid/doxygen-doc