Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате
Форум программистов > Perl: Общие вопросы > Документирование кода Perl с помощью Doxygen


Автор: Гость_Юрий 7.9.2005, 12:00
Доброго времени суток.
У меня возникло пара вопросов по системе документирования кода с помощью Doxygen.

В теории эта кроссплатформенная система может создавать документацию для кода написанного на множестве языков: Java, C/C++, Objective-C, Python, IDL (Corba and Microsoft flavors) и так далее. Но в основном для C/C++ и Java.
Как написано на сайте http://www.stack.nl/~dimitri/doxygen/helpers.html эта система может обрабатывать документацию для Perl'а написанную в формате POD. Для этого необходимо установить специальный фильтр DoxyFilt для Doxygen.
В сети я так и не смог найти откуда взять этот фильтр или как его использовать.

Волнуют следующие вопросы:
1. Кто-нибудь использует Doxygen для документирования кода на Perl?
2. Если используете, что для этого нужно?

Автор: korob2001 8.9.2005, 18:53
Документация в POD формате заключается в сам код, делается это очень просто, почитать об этом можно практически в любом учебнике по Perl. В Java документация тоже создаётся довольно просто при помощи javadoc от Sun.
Если не трудно, поясни, для чего это нужно, просто я в ленгвиче не силён. smile((

Автор: Гость_Юрий 12.9.2005, 12:13
2korob2001

Спасибо за ответ.
С документированием исходников на Perl в формате POD все абсолютно ясно также как и в Java, стандартными средствами.

Все дело в том, что у нас в Компании мы стремимся использовать, по возможности, один инструмент для документации. И для этого было решено использовать Doxygen, так как он позволяет использовать единый стандарт для нескольких языков программирования.

По умолчанию он поволяет документировать код для C++ и Java, но с подключением фильтров и дополнительной настройки его можно использовать и для Visual Basic, Perl и т.д.

Но с подключением этих возможностей у меня и возникли проблемы. Если кто-нибудь использует Doxygen для Perl'а, скажите как вы это делаете. Буду очень признателен.

То же самое с средой для разработки IDE. Например, как универсальную среду для разработки мы используем http://www.eclipse.org/. Во-первых, она бесплатная, а во-вторых кроссплатформенная. Она поддерживает технологию Plug-In для подключения новых возможностей и поддержки языков программирования. Что очень удобно: не надо запоминать где, что находится в разных IDE, если вы пишете на разных языках.


Powered by Invision Power Board (http://www.invisionboard.com)
© Invision Power Services (http://www.invisionpower.com)