Perl POD 文档

Perl POD 文档
Perl 中可以在模块或脚本中嵌入 POD(Plain Old Documentation) 文档。

POD 是一种简单而易用的标记型语言(置标语言)。

POD 文档使用规则:

POD 文档以 =head1 开始, =cut 结束, =head1 前与 =cut 后添加一空行。

Perl 会忽略 POD 中的文档。实例如下:



实例

#!/usr/bin/perl
 
print "Hello, World\n";
 
=head1 Hello, World 实例
这是一个 Perl 的简单实例。
=cut
 
print "Hello, Geekdoc\n";

执行以上程序,输出结果为:

Hello, World
Hello, Geekdoc

我们还可以使用 “__END__” 或 “__DATA__” 将所在行之后的内容全部”注释”掉:

实例

#!/usr/bin/perl
 
print "Hello, World\n";
 
while(<DATA>){
  print $_;
}
 
__END__
 
=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, Geekdoc\n";

执行以上程序,输出结果为:



Hello, World

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, Geekdoc\n";

以下实例不读取 POD 文档:

实例

#!/usr/bin/perl
 
print "Hello, World\n";
 
__END__
 
=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, Geekdoc\n";

执行以上程序,输出结果为:

Hello, World

什么是 POD?

Pod(Plain Old Documentation), 是一种简单而易用的标记型语言(置标语言),它经常用于在perl程序和模块中的文档书写。



Pod 的 转化器可以将 Pod 转换成很多种格式,例如 text, html, man 等很多。

Pod 标记语言包含三种基本基本类型: 普通, 原文, 和 命令。

  • 普通段落: 你可以在普通段落中使用格式化代码,如黑体,斜体,或代码风格,下划线等。

  • 原文段落: 原文段落,用于代码块或者其他不需要转换器处理的部分,而且不需要段落重排。

  • 命令段落: 命令段落作用于整个的文档,通常用于标题设置或列表标记。

    所有的命令段落(他只有一行的长度)使用 “=” 开始,然后是一个标识符。 随后的文本将被这条命令所影响。现在被广泛使用的命令包括

    =pod (开始文档)
    =head1 标题文本
    =head2 标题文本
    =head3 标题文本
    =head4 标题文本
    =over 缩进空格数量
    =item 前缀
    =back (结束列表)
    =begin 文档格式
    =end 结束文档格式
    =for 格式文本
    =encoding 编码类型
    =cut (文档结束)

在perl中,可以使用 pod2html **.pod >**.html 来生成html格式的pod文档。

考虑以下 POD 实例:

实例

=begin html
=encoding utf-8
 
=head1 极客教程
 
=cut

pod2html时会原文拷贝此段代码。

使用 pod2html 命令执行,将其转换为 HTML 代码:

$ pod2html test.pod > test.html

以下实例在 POD 文档中直接写入 HTML:

=begin html
=encoding utf-8

<h1>极客教程</h1>
<p> www.geek-docs.com </p>

=end html

pod2html时会原文拷贝此段代码。

使用 pod2html 命令执行,将其转换为 HTML 代码:

$ pod2html test.pod > test.html


Perl 教程
Perl 教程Perl 安装配置第一个 Perl 程序Perl 语法Perl 中的数据类型Perl 变量Perl 局部和全局变量Perl 中的标量Perl use strict和use warningsPerl 列表和数组Perl 中的哈希Perl 运算符Perl 中的条件语句Perl 中的if语句Perl 中的if-else语句perl 中的if-elsif-else语句Perl 中的unless语句Perl 中的unless-else语句Perl 中的 Switch CasePerl 中的 given-when-default 语句Perl 中的循环和循环控制语句Perl 中的 for 循环Perl while 循环Perl do-while 循环Perl foreach 循环Perl 中的until循环Perl 中的子程序Perl 字符串Perl 字符串转义序列Perl BarewordsPerl 比较文件的内容Perl 根据行号显示文件内容Perl 加密和解密Perl 错误处理Perl 格式Perl 函数签名Perl Hello World程序Perl 简介编写Perl代码的模式使用Perl的数字猜测游戏Perl 面向对象的编程(OOPs)Perl 包Perl abs()函数Perl 使用文件全局访问一个目录Perl Regex中的锚点Perl 向文件追加内容Perl 数组 pop() 函数Perl 数组切片Perl 数组 (push、pop、shift、unshift)Perl 数组Perl Regex中的断言Perl atan2() 函数Perl 自动加载(AUTOLOAD)功能Perl 字符串到数字的自动转换或铸造Perl 引用中的自生现象Perl 正则表达式中的回溯操作Perl Perl程序的基本语法Perl 布尔值Perl 调试器的中断点Perl CGI编程Perl chomp()函数Perl chop()函数Perl chr()函数Perl OOP中的类Perl cmp 操作符Perl 比较标量Perl 构造函数和析构函数Perl cos()函数Perl 计算文本中单词的频率Perl 创建Excel文件Perl 数据类型Perl 日期和时间Perl DBI(数据库独立接口)模块集Perl 分支 (if, if-else, Nested-if, if-elsif ladder, unless, unless-else, unless-elsif)Perl defined()函数Perl delete()函数Perl 带有CRUD操作的目录Perl 用调试器显示变量值Perl each() 函数Perl 正则表达式中的'e'修改器Perl 正则表达式中的'ee'修改器Perl OOPs中的封装Perl eq运算符Perl exists() 函数Perl 从脚本中退出Perl exp函数Perl 使用Regex从一个字符串中提取IP地址Perl 文件处理简介Perl 文件输入输出功能Perl 文件锁定Perl 文件测试运算符Perl CGI中的文件上传Perl 查找文件和目录Perl ge运算符Perl CGI中的GET与POSTPerl getc函数Perl 获取一个数组的元素数Perl given-when 语句Perl glob()函数Perl goto 语句Perl grep()函数Perl Regex中的分组和交替法Perl gt运算符Perl 标量和列表背景下的哈希值Perl 哈希操作Perl HashPerl 哈希值Perl hex函数Perl 实现一个队列Perl 实现一个堆栈Perl index() 函数Perl OOPs中的继承性Perl 在Windows、Linux和MacOS中的安装和环境设置Perl int()函数Perl join()函数Perl keys() 函数Perl 循环中的lastPerl lc()函数用于小写转换Perl lcfirst()函数Perl le运算符Perl length()函数Perl 调试器中的行操作命令Perl 列表及其类型Perl 列表的上下文敏感度Perl 列表函数Perl log() 函数Perl 循环 for, foreach, while, do...while, until, 嵌套循环Perl lt运算符Perl 匹配运算符
Perl 基础教程
Perl 简介Perl 环境安装Perl 基础语法Perl 数据类型Perl 变量Perl 标量Perl 数组Perl 哈希Perl 条件语句Perl 循环Perl 运算符Perl 时间日期Perl 子程序(函数)Perl 引用Perl 格式化输出Perl 文件操作Perl 目录操作Perl 错误处理Perl 特殊变量Perl 正则表达式Perl Socket 编程Perl 面向对象Perl 包和模块Perl 进程管理Perl POD 文档Perl while 循环Perl until 循环Perl for 循环Perl foreach 循环Perl do…while 循环Perl 循环嵌套Perl next 语句Perl last 语句Perl continue 语句Perl redo 语句Perl goto 语句Perl IF 语句Perl IF…ELSE 语句Perl IF…ELSIF 语句Perl UNLESS 语句Perl UNLESS…ELSE 语句Perl UNLESS…ELSIF 语句Perl switch 语句
Perl 问答
Perl 和 Ruby 的区别