Главная страница>Учебник по сетевому программированию>Учебник по Perl

Документация Perl POD

Автор：Eve Cole Время обновления：2024-12-24 16:24:01

В Perl документы POD (Plain Old Documentation) могут быть встроены в модули или сценарии.

POD — простой и удобный в использовании язык разметки (язык разметки).

Правила использования документа POD:

Документ POD начинается с =head1 и заканчивается =cut . Добавьте пустую строку перед =head1 и после =cut .

Perl игнорирует документацию в POD. Примеры следующие:

Пример

#!/usr/bin/perl распечатать " Hello, World n " ; =head1 Привет, World Пример Это простой пример Perl. = вырезать распечатать " Привет, Codercto n " ;

Результат выполнения вышеуказанной программы:

 Привет, мирПривет, Codercto

Мы также можем использовать «__END__» или «__DATA__», чтобы «закомментировать» весь контент после строки:

Пример

#!/usr/bin/perl распечатать " Привет, мир n " ; while ( < ДАННЫЕ > ) { распечатать $ _ ; __КОНЕЦ__ =head1 Привет, мир Пример Это простой пример Perl. напечатайте «Привет, Codercton»;

Результат выполнения вышеуказанной программы:

 Hello, World=head1 Привет, World Пример Это простой пример Perl. напечатайте «Привет, Codercton»;

В следующем примере документ POD не читается:

Пример

#!/usr/bin/perl распечатать « Привет, мир n » __END__ ; =head1 Привет, мир Пример Это простой пример Perl. напечатайте «Привет, Codercton»;

Результат выполнения вышеуказанной программы:

 Привет, мир

Что такое ПОД?

Pod (Plain Old Documentation) — простой и удобный в использовании язык разметки (язык разметки), который часто используется для написания документов в программах и модулях на Perl.

Конвертер Pod может конвертировать Pod во многие форматы, такие как текстовый, html, man и т. д.

Язык разметки Pod содержит три основных типа: обычный, текстовый и командный.

Обычные абзацы : в обычных абзацах можно использовать коды форматирования, например жирный шрифт, курсив или стиль кода, подчеркивание и т. д.

Исходный абзац : Исходный абзац, используемый для блоков кода или других частей, которые не требуют обработки конвертером и не требуют перестановки абзацев.

Параграф команды : Параграфы команды действуют на весь документ и обычно используются для настройки заголовка или разметки списка.

Все абзацы команд (длиной всего одну строку) начинаются с «=", за которым следует идентификатор. Эта команда повлияет на последующий текст. Сейчас широко используемые команды включают в себя

 =pod (начальный документ)=текст заголовка заголовка1=текст заголовка заголовка2=текст заголовка3=текст заголовка4=больше количества отступов=префикс элемента=назад (конец списка)=начало формата документа=конец формата конца документа=для текста формата =кодирование тип кодировки=вырезать (конец документа)

В Perl вы можете использовать pod2html **.pod >**.html для создания документов модуля в формате html.

Рассмотрим следующий экземпляр POD:

Пример

=begin html=кодировка utf-8 =head1 Учебное пособие для программиста =cut

При использовании pod2html этот код будет скопирован из исходного текста.

Используйте команду pod2html для выполнения и преобразования ее в HTML-код:

 $ pod2html test.pod > test.html

Откройте test.html в браузере, часть ссылки — это индекс, как показано ниже:

В следующем примере HTML записывается непосредственно в документ POD:

 =begin html=encoding utf-8<h1>Руководство по программированию</h1><p> www.codercto.com </p>=end html

При использовании pod2html этот код будет скопирован из исходного текста.

Используйте команду pod2html для выполнения и преобразования ее в HTML-код:

 $ pod2html test.pod > test.html

Откройте test.html в браузере, часть ссылки — это индекс, как показано ниже:

Связанные статьи