Содержание
Хотя когда-то это был неотъемлемый язык для веб-программирования
Теперь Perl отошел на второй план в пользу более современных языков, таких как Python, Ruby и JavaScript. Мало кто думает, что в наши дни стоит учить Perl.
Но это не значит, что язык бесполезен или устарел. Фактически, многие современные веб-сайты и веб-инструменты по-прежнему полагаются на Perl для повседневных операций, включая Craigslist, IMDb и DuckDuckGo, поэтому, если вы заинтересованы в изучении этого, не позволяйте никому останавливать вас или отговаривать вы
,
Если вы собираетесь изучать Perl, вы также захотите познакомиться с POD. Вот что это такое, почему это важно и что делать, когда вы запускаете такие файлы.
Что такое файлы POD?
POD расшифровывается как Plain Old Documentation, который является основным языком разметки, который используется для форматирования текста без особых усилий. Это похоже на язык разметки Markdown
, но специально разработан для документирования исходного кода и модулей Perl.
POD можно использовать двумя способами: он может существовать непосредственно в исходном коде файла Perl ИЛИ он может существовать как отдельный файл POD. Когда он существует в коде, вы можете думать о нем как о комментариях на любом другом языке программирования, кроме более изящного и более гибкого.
#! / USR / бен / Perlиспользовать строгое;
использовать предупреждения;
= стручок
= head1 Пример заголовка
Этот скрипт делает что-то классное, как то так и так. Для правильной работы должны существовать следующие параметры. Не пытайтесь делать это на машине с проблемами.
= вырезать
print «Только этот код выполняется. \ П»;
Встроенная документация хорошо работает для автономных сценариев или когда вы хотите убедиться, что любой, кто сталкивается с файлом, также имеет гарантированный доступ к документации, но это может быть громоздким, если вы хотите документировать всю кодовую базу на более высоком уровне.
К счастью, POD также можно использовать для создания страниц ручного типа, которые лучше подходят для ориентированных на пользователя документов (поскольку пользователи могут не захотеть копаться в исходном коде самого скрипта). Вот тогда пригодятся файлы POD.
Как читать файлы POD
Чтобы быть понятным, встроенная документация POD находится в реальных файлах сценариев Perl между строками кода, и эти файлы сценариев имеют один из двух расширенных форматов: .PL или .PM. Когда вы видите расширение .POD, это указывает на то, что файл является чистой документацией и не содержит исходного кода.
Хотя открыть файлы POD можно в любом текстовом редакторе, в том числе в «Блокноте», вы, вероятно, захотите это сделать, только если вы действительно редактируете исходную документацию. Думайте об этом, как об открытии HTML-файла в редакторе: со всей разметкой фактический текстовый контент трудно читать.
Вместо этого вы должны использовать какой-то инструмент для чтения, который берет сырую документацию POD и представляет ее в удобном для чтения виде.
Самый простой способ — это использовать perldoc инструмент командной строки, который автоматически включается при установке Perl в вашу систему. Большинство систем OS X и Linux поставляются с уже установленным Perl, но пользователи Windows должны будут установить его вручную. (К счастью, это не сложнее, чем запустить установочный файл.)
Теперь запустите командную строку, перейдите туда, где находится файл POD, и введите perldoc [.POD файл] чтобы просмотреть его как правильно отформатированный. Например, если файл был назван library.pod тогда вы наберете perldoc library.pod и это все.
Как конвертировать POD в другие форматы
Хотя perldoc инструмент не слишком сложен в использовании, он не совсем удобен, когда вы хотите поделиться документацией с другими или когда вы хотите прочитать ее с вашего компьютера. Вот когда вы можете рассмотреть возможность преобразования в другой формат.
Преобразование в HTML: Установите и используйте инструмент pod2html, который обеспечивает простой способ перевода любого файла POD в читаемый HTML-файл. К сожалению, он может выполнять только преобразование один-к-одному (поэтому вы не можете объединить несколько файлов POD в один файл HTML).
Преобразование в PDF: Установите и используйте инструмент pod2pdf, который похож и так же прост в использовании, как и инструмент pod2html выше, за исключением того, что он конвертируется в PDF, а не в HTML.
Другой вариант — преобразовать POD в HTML, используя метод, показанный выше, открыть файл HTML в браузере, например Chrome или Firefox, а затем распечатать страницу в формате PDF.
Преобразование в уценку: Установите и используйте инструмент pod2markdown для перевода между POD и Markdown. Markdown — это язык разметки общего назначения, означающий, что пользователи, скорее всего, знакомы с ним, и есть больше инструментов, которые могут принимать и отображать Markdown.
Преобразование в LaTeX: Установите и используйте инструмент pod2latex. LaTeX — еще один язык разметки, менее распространенный, чем Markdown, но все же более популярный, чем POD. LaTeX в основном используется в научных и научных документах, но в случае необходимости этот конвертер существует.
Преобразование в обычный текст: Установите и используйте инструмент pod2text, который создает текстовый файл с форматированием на основе ASCII. Вам, вероятно, не нужно будет использовать это, но если вы когда-либо это сделаете, знайте, что опция существует.
Был ли этот пост полезным?
Как только вы освоите его, POD-файлы станут чрезвычайно простыми и удобными в использовании. Есть некоторая кривая обучения, но она очень незначительна — особенно если вы раньше использовали язык разметки. Надеюсь, теперь вы чувствуете себя комфортно, имея дело с файлами POD.
Если вы чувствуете себя подавленным, задайте себе эти важные вопросы для начинающих программистов
, Наличие трудностей не обязательно означает, что вы не должны быть программистом
, но важно быть честным с собой и управлять своими ожиданиями.
Тем не менее, прислушайтесь к этим советам, чтобы научиться кодировать без стресса
и зная, как отличить хорошие учебники по кодированию от плохих
,
Для чего вы используете Perl? Есть какие-либо другие советы, которыми можно поделиться или вопросы задать? Дайте нам знать в комментариях ниже!
