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

Question

У Perl есть Perl Docs генератор? Что-то вроде Java Docs или PHP Documenter?

Answer 1

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

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

Вкратце, «= элемент» является маркированным изделием, например. функция или параметр «= 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, чтобы получить отформатированную документацию.

Answer 2

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

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

• What’s the best way to document Perl code?

Answer 3

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

Answer 4

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

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

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

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