Как я могу создать HTML-документацию для комментариев кода Perl?

Я пришел в собственность кучу кода, который содержался вместе с различными сценариями Perl. Там есть документация в виде комментариев (не Pod), встроенных в эти сценарии, которые я хотел бы извлечь и просматривать в формате HTML.

В принципе, я ищу что-то вроде javadoc или rubydoc, но для Perl. "perldoc" казался очевидной строкой поиска, но я предполагаю, что это просто документация для самого Perl. "perlpod" также появился, но я ищу что-то, что извлекает комментарии, которые уже существуют в коде без особого форматирования. (Необходимость добавления дополнительных битов представляется контрпродуктивной.)

Какой бы инструмент я ни выбрал, я хотел бы указать его на код и рекурсивно найти файлы Perl, создать документацию и сохранить его в выбранной мной директории. Он также должен быть кросс-платформенным (Windows XP, 7, Mac OS X и Ubuntu Linux). Что-то, написанное на Perl, похоже, будет квалифицироваться. Он также должен хорошо играть с другими языками программирования, если это возможно.

Какие варианты вы бы рекомендовали?

Извините за мое незнание - я никогда раньше не делал ничего сверх простых вещей с Perl.

Ответ 1

У меня нет опыта, но Pod::Autopod выглядит интересным. Он поставляется с утилитой командной строки autopod.

autopod - использование библиотеки Perl Pod:: Autopod для генерации javadoc как документации с синтаксисом pod. Он предназначен для понимания кода Perl в стиле класса, поэтому обычно файлы PM.

Возможно, стоит посмотреть. Пожалуйста, сообщите нам, если вы попробуете.

Ответ 2

Если ваши файлы Perl содержат Perl Plain Old Documentation (POD), вы можете использовать pod2html для создания HTML.

Или, может быть, вы можете адаптировать это в соответствии с вашими потребностями: Комментарии к POD - com2pod.pl

Ответ 3

Посмотрите больше на perldoc. Это инструмент для просмотра и генерации документации модуля, а также инструмент командной строки для чтения документации Perl.

Например, вы можете создать HTML файл модуля модуля с помощью

perldoc -o html path/to/Module.pm

Ответ 4

Документация в комментариях? Это две разные концепции. Комментарии для программиста по обслуживанию, документация для пользователя.

Как очень неразумно. Что подумают о нелепых новичках? ° _ °;

Преобразуйте текст из формы комментария в POD, что означает удаление символов # и привязка некоторых соответствующих =command paragraphs выше и ниже. Затем вы можете использовать целую цепочку POD для проверки, преобразования и т.д.

Ответ 5

Natural Docs написан на Perl и может документировать несколько языков. Он довольно гибкий с точки зрения того, что он может документировать. Я почти уверен, что он может сделать все, о чем вы просили здесь. Посмотрите на это!

Ответ 6

В ретроспективе (2,5 года спустя) Docco, возможно, выполнила именно то, что я искал: http://jashkenas.github.com/docco/

Ответ 7

Как насчет Doxygen? Это инструмент для документации по программному обеспечению, первоначально написанный для C/С++. Он очень похож на JavaDoc, но поддерживает несколько языков программирования (например, C/С++, С#, Objective-C, Java, Python, PHP, ecc..).

Существует также версия на основе Perl: Doxygen:: Filter:: Perl

Здесь вы можете найти всю документацию: http://www.stack.nl/~dimitri/doxygen/manual/commands.html

Я лично нашел его намного более полезным, чем POD, особенно потому, что сразу можно увидеть (также из кода), какой метод или функция примет в качестве параметра и/или что он будет возвращать.

Ответ 8

Мне нравится Doxygen. Doxygen Filter позволяет использовать комментарии стиля Doxygen для документирования кода Perl, который, как JavaDoc. doxygen