Есть ли в Perl что-то вроде Java/PHP Docs?

Ответ 1

Да, он называется perldoc

Вы просто пишете документацию в источнике, как и с javadoc.

Вкратце, "= item" - это маркированный элемент, например. функция или параметр "= over" опускается на уровень идентификации, "= назад" поднимается на уровень. Используйте "= cut", где вы хотите вернуться к Perl-коду.

Вот пример того, как он может выглядеть:

=item $b->add_module ( %options )

Initialize a module. A module is a repository or a branch of a repository.
Valid options are

=over

=item id

Id of this module

=item repo

Url of repository. Currently only subversion repositories are supported.

=back

=cut
sub add_module($%)
{

Просто передайте свой Perl-код через программу perldoc, чтобы получить отформатированную документацию.

Ответ 2

Вы имеете в виду perldoc?

Также см. этот связанный вопрос о переполнении стека:

• Каким образом можно документировать код Perl?

Ответ 3

Почему, да. Да! Perldoc.

Ответ 4

[только для гуглеров] Как уже говорили люди, вы делаете документацию с POD (не комментарии, комментарии для сопровождающих, pod для документации пользователя). Обычно вы добавляете POD в начале и конце вашего script или модуля, а перед каждым методом), вы можете использовать perldoc your_module в консоли или pod2html для преобразования в html и просмотра на сервере или используйте pdoc (это немного устарело, но очень полезно, когда вы хотите иметь навигатор веб-документа и ссылки на код в Интернет).

возникает новый вопрос о форматировании контейнера, который может быть и вашего интереса perl-documentation-pod-browsers

и этот how-can-i-generate-html-documentation-for-perl-code-comments

И еще один говорил о том, чтобы сделать pod2html и использовать файл css для имитации страниц cpansearch, но я не могу найти его сейчас.