Лучшее руководство по Perl СТРУЧОК документация в 2024 году. В этом руководстве вы можете изучить Что такое POD?,
Perl может быть встроен POD (Plain Old Documentation) в документации модуля или сценария.
POD является простым и легким в использовании тегов на основе языка (язык разметки).
СТРУЧОК документации с использованием правил:
СТРУЧОК документация начинается с= head1, = обрезанныйконец, и перед= head1= вырезать после добавления пустую строку.
Perl игнорирует документацию стручка. Примерами могут служить следующие:
#!/usr/bin/perl print "Hello, World\n"; =head1 Hello, World 实例 这是一个 Perl 的简单实例。 =cut print "Hello, w3big\n";
Вышеприведенная программа, выход:
Hello, World Hello, w3big
Мы также можем использовать "__END__" или "__DATA__" после того, как содержимое строки, в которой все «Комментарии» из:
#!/usr/bin/perl print "Hello, World\n"; while(<DATA>){ print $_; } __END__ =head1 Hello, World 实例 这是一个 Perl 的简单实例。 print "Hello, w3big\n";
Вышеприведенная программа, выход:
Hello, World =head1 Hello, World 实例 这是一个 Perl 的简单实例。 print "Hello, w3big\n";
Следующие примеры не прочитать СТРУЧКА документации:
#!/usr/bin/perl print "Hello, World\n"; __END__ =head1 Hello, World 实例 这是一个 Perl 的简单实例。 print "Hello, w3big\n";
Вышеприведенная программа, выход:
Hello, World
Pod (Plain Old Documentation), является простым и легким в использовании тегов на основе языка (язык разметки), он часто используется в Perl программ и модулей, написанных в документе.
преобразование Pod Pod могут быть преобразованы в различные форматы, такие как текст, HTML, человек много и так далее.
Pod разметки состоит из трех основных базовых типов: нормальные, оригинальные, и команды.
Нормальный пункт: Вы можете использовать коды форматирования в обычных пунктах, таких как полужирный, курсив, или кодирование стиля, подчеркивание.
Первоначальный абзац: фрагменты текста, для части блока кода или другой обработки преобразователя не требуется, но не требует пункт перегруппировку.
Команда Пункт: роль Пункт Command во всем документе или список часто используемых для установки теги заголовков.
Все пункты команды (его только длина линии) с использованием "=", а затем является идентификатором. Последующий текст будет зависеть от этого приказа. Команда в настоящее время широко используются, включают
=pod (开始文档) =head1 标题文本 =head2 标题文本 =head3 标题文本 =head4 标题文本 =over 缩进空格数量 =item 前缀 =back (结束列表) =begin 文档格式 =end 结束文档格式 =for 格式文本 =encoding 编码类型 =cut (文档结束)
В Perl вы можете использовать pod2html **. Pod> **. Html для создания формата стручок HTML документа.
СТРУЧОК Рассмотрим следующие примеры:
=begin html =encoding utf-8 =head1 本教程 =cut
Этот код будет оригинал, когда pod2html.
Используйте pod2html выполнить команду, чтобы преобразовать его в HTML-код:
$ pod2html test.pod > test
Откройте test браузера, раздел для индекса ссылки, приведен ниже:
Следующие примеры записываются непосредственно в POD документации HTML:
=begin html =encoding utf-8 <h1>本教程</h1> <p> www.w3write.com </p> =end html
Этот код будет оригинал, когда pod2html.
Используйте pod2html выполнить команду, чтобы преобразовать его в HTML-код:
$ pod2html test.pod > test
Откройте test браузера, раздел для индекса ссылки, приведен ниже: