Doxygen |
Автор: admin Просмотров: 3669 Комментарии:
Добавлен: 8 апреля 2016
Обновлено: 15.04.2016 - 08:57
Doxygen - кроссплатформенная система документирования исходных текстов программ, которая поддерживает C++, Си, Objective-C, Python, Java, IDL, PHP, Perl, C#, Фортран, VHDL и частично, D .
Doxygen генерирует документацию основываясь на наборе исходных кодов и даже может извлекать структуры программы по недокументированным исходным текстам. Возможно составление графов зависимостей программных объектов, диаграмм классов и исходных кодов с гиперссылками .
Пример программы на языке C ++ (сгенерирована документация - на рисунке):
class Time {
public :
/ **
* Constructor that sets the time to a given value .
*
* @param Timemillis Number of milliseconds
* passed since Jan 1, 1970
* /
Time ( int timemillis ) {
// the code
}
/ **
* Get the current time.
*
* @return A time object set to the current time .
* /
Static Time now () {
// the code
}
};
Doxygen имеет встроенную поддержку генерации документации в формате LaTeX, man, HTML, XML и RTF. Также результаты его работы можно легко конвертировать в PostScript, PDF, CHM.
Для HTML -представление документации, размещается на web-серверах, существует удобный способ организации поиска (с помощью создаваемого Doxygenом PHP -модуля) и ссылок на внешнюю документацию.
Doxygen используется во многих проектах, в том числе FOX toolkit , Crystal Space, KDE , Torque Game Engine, Pidgin, AbiWord , Drupal, Mozilla. Есть встроенная поддержка в KDevelop .
Doxygen - консольная программа в стиле классического Unix . Doxygen работает подобно компилятору, анализируя исходные коды и создавая документацию. Дополнительные параметры для создания документации могут читаться с конфигурационного файла в простом текстовом формате.
Для упрощения манипуляций с файлами конфигураций (которые содержат достаточно много настроек), существует несколько программ с графическим интерфейсом: программа doxywizard (реализована с использованием Qt -3) поставляется вместе с Doxygen; программа Doxygate основана на Qt версии 4. Позже doxywizard был переписан на Qt 4, а затем Doxygate был закрыт.
Создание документов из исходных кодов
Doxygen является де-факто стандартным инструментом для создания документации из аннотированных исходников C++, но также поддерживает и другие популярные языки программирования, такие как C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, и UNO/OpenOffice flavors), Fortran, VHDL, Tcl, и некоторые расширения D.
Зачем нужен Doxygen ?
- Может генерировать онлайн просмотр документации (в формате HTML) и/или оффлайн справочное руководство (в LaTeX) из набора документированных исходников. А также поддерживает вывод в форматы RTF (MS-Word), PostScript, PDF с гиперссылками, сжатый HTML и в справочные страницы Unix. Документация извлекается непосредственно из исходников, что позволяет держать документацию в соответствии с исходными текстами.
- Вы можете настроить Doxygen для извлечения структуры кода из недокументированных исходных файлов. Это бывает полезно, когда нужно быстро найти свои пути в длинных исходниках. Doxygen также может визуализировать взаимосвязи между различными элементами с помощью включенных зависимостей диаграмм, диаграмм наследования и схем взаимосвязей, которые все генерируются автоматически.
- Вы можете также использовать Doxygen для создания нормальной документации (как это сделал разработчик Doxygen для инструкции по Doxygen и по своему веб-сайту).
Doxygen разработан под Mac OS X и GNU/Linux, но устанавливается без инсталятора, чтобы быть портативным. В результате, он работает на большинстве других Юниксов и даже имеет бинарник под Windows.
https://en.wikipedia.org/wiki/Doxygen
https://www.stack.nl/~dimitri/doxygen/
------------------------
ТРИО теплый пол отзыв
Заработок на сокращении ссылок
Earnings on reducing links
Код PHP на HTML сайты
Я уже пять лет не занимаюсь сайтом, так как работаю по 12 часов. Образование у меня среднее, и по этому нет нормальной работы. Если бы сайт приносил по 100$ в месяц, я бы добавлял по 50 статей каждый месяц. Если отправите пожертвования, я оставлю Ваши имена и фамилии в списке благодетелей !
Bitcoin: 1AP3JCZVFpHzZwcAyNztbrbFFiLdnKbY1j
Litecoin LfHXHz4k6LnDNNvCodd5pj9aW4Qk67KoUD
Dogecoin D9HHvKNFZxRhjtoh6uZYjMjgcZewwiUME9
Есть также другие кошельки.
Категория: Документация, Анализаторы исходных текстов
Лицензия:
GPL
Интерфейс графический
Язык программирования:
C, C#, C++, Java, Objective-C 2.0, PHP
Сайт проекта
Скачать Doxygen
Комментарии |
Информация Комментирование данной новости запрещено. |