Есть ли в Perl что-то вроде Java / PHP Docs? - PullRequest
10 голосов
/ 25 января 2010

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

Ответы [ 4 ]

13 голосов
/ 25 января 2010

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

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

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

7 голосов
/ 25 января 2010

Да, да. Да, это так! Perldoc .

7 голосов
/ 25 января 2010

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

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

2 голосов
/ 25 мая 2011

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

появился новый вопрос о форматировании пакета, который также может вас заинтересовать Perl-документация-стручка-браузеры

и этот how-can-i-generate-html-документация-для-perl-code-comments

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

...