Perl поставляется с большим количеством документации, однако пройдет некоторое время, пока вы научитесь ею пользоваться. В этой главе Учебника по Perl я расскажу вам, с какой стороны лучше к ней подступиться.
perldoc в Сети
Удобнее всего читать основную документацию Perl на сайте perldoc.
Там представлена HTML-версия документации на Perl, как язык, а также документация на модули, которые идут в основной сборке Perl, выпускаемой командой Perl 5 Porters.
На этом сайте нет документации на модули из CPAN. Хотя существует некоторое пересечение, так как часть модулей, доступных на CPAN, входит также в стандартную поставку Perl. (Они часто упоминаются как dual-lifed, или «живущие двойной жизнью»).
Попробуйте окно поиска в правом верхнем углу. Например,
введите там split, и вам будет показана документация на split.
К сожалению, поиск не знает, ни что делать с while, ни с
$_ или @_. Чтобы получить их описания,
Вам придется пролистать документацию.
Самой важной страницей может стать perlvar,
где можно найти информацию о переменных, таких как $_ или @_.
perlsyn рассказывает о синтаксисе Perl, в том числе о цикле while.
perldoc в командной строке
Та же самая документация поставляется и с исходным кодом Perl, однако
не во всяком дистрибутиве она устанавливается по умолчанию. Иногда
это отдельный пакет. Например, в Debian и Ubuntu это пакет perl-doc.
Вам нужно установить его командой sudo aptitude install perl-doc,
прежде чем вы сможете пользоваться perldoc.
После установки введите в командной строке perldoc perl,
и вы получите список разделов документации Perl и краткую инструкцию как всем этим пользоваться.
Вы можете выйти при помощи клавиши q, а затем набрать имя одного из разделов.
Например: perldoc perlsyn.
Этот способ работает как на Linux, так и на Windows, хотя пейджер Windows на самом деле слаб, я не могу вам его рекомендовать. В Linux запустится стандартное приложение чтения man, с которым вы наверняка хорошо знакомы.
Документация модулей CPAN
Каждый модуль на CPAN поставляется с документацией и примерами. Количество и качество этой документации весьма неоднородно среди разных авторов; впрочем, даже у одного автора могут встречаться как хорошо документированные модули, так и модули с очень слабой документацией.
После того как вы установили модуль, который называется, к примеру, Module::Name,
его документация доступна по команде perldoc Module::Name.
Однако есть существенно более удобный способ, который даже не требует установки модуля. Есть несколько различных веб-интерфейсов к CPAN. Основными из них являются Meta CPAN и поиск по CPAN.
Оба они дают доступ к одной и той же документации, однако работают немного по-разному.
Поиск по ключевым словам на Perl Maven
Недавнее дополнение к этому сайту – поиск по ключевым словам в верхней строке меню. Со временем вы будете находить все больше объяснений различным аспектам perl. В какой-то момент будет вкючена часть основной документации Perl и документация наиболее важных модулей из CPAN.
Если вам не удается что-то там найти, просто оставьте комментарий к оригиналу этой статьи (англ.) с указанием ключевых слов, которые вам не удалось найти, и мы постараемся вам помочь.
