Инструмент для документирования исходных кодов

http://www.doxygenorg.ru/

Инструмент для документирования исходных кодов

Doxygen - система документирования для C++, C, Java, Objective-C, Python, IDL (Corba и Microsoft flavors), Fortran, VHDL, PHP, C#, и до некоторой степени D.

Она может помочь Вам в трех случаях:

1. Система может генерировать документацию как для просмотра он-лайн (в HTML) так и в виде справочного описания (в $mbox{LaTeX}$) из набора исходных файлов. Также возможен вывод в форматы: RTF (MS Word), PostScript, hyperlinked PDF, compressed HTML и в страницы помощи Unix man. Документация формируется непосредственно из исходников, что делает более легким сохранение соответствия документации с исходными текстами.
2. Вы можете сконфигурировать doxygen, чтобы извлечь структуру кода из неописанных исходных файлов. Это очень полезно для быстрой ориентации в распространяемых больших исходных текстах. Вы можете также визуализировать отношения между различными элементами посредством включения графов зависимости, диаграмм наследования и диаграмм взаимоотношения, которые генерируются автоматически.
3. Вы можете даже 'нарушить режим эксплуатации' doxygen для того, чтобы создать нормальную документацию (поскольку я сделал для этого руководства).

Doxygen разработан под Linux и Mac OS X, но является переносимым. В результате он выполняется также на большинстве других разновидностях Unix. Кроме того, доступны версии для выполнения под ОС Windows.