Perl
+ -

Perl POD 文档

2019-09-09 3 0

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, bytekits\n";

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

Hello, World
Hello, bytekits

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

实例

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

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

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

以下实例不读取 POD 文档:

实例

#!/usr/bin/perl
print "Hello, World\n";
__END__
=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, bytekits\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

在浏览器中打开 test.html,链接部分为索引.

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

=begin html
=encoding utf-8
<h1>字节流</h1>
<p> http://www.bytekits.com </p>
=end html

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

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

$ pod2html test.pod > test.html

在浏览器中打开 test.html,链接部分为索引,显示.

0 篇笔记 写笔记

C# 索引器(Indexer)
索引器(Indexer) 允许一个对象可以像数组一样被索引。当您为类定义一个索引器时,该类的行为就会像一个 虚 拟数组(virtualarray) 一样。您可以使用数组访问运算符([ ])来访问该类的实例。语法一维索引器的语法如下:element-type this[int index] { /......
Perl 引用
引用就是指针,Perl 引用是一个标量类型可以指向变量、数组、哈希表(也叫关联数组)甚至子程序,可以应用在程序的任何地方。创建引用定义变量的时候,在变量名前面加个,就得到了这个变量的一个引用,比如:$scalarref = $foo; # 标量变量引用$arrayref = @ARG......
MongoDB 关系
MongoDB 的关系表示多个文档之间在逻辑上的相互联系。文档间可以通过嵌入和引用来建立联系。MongoDB 中的关系可以是:1:1 (1对1)1: N (1对多)N: 1 (多对1)N: N (多对多) 接下来我们来考虑下用户与用户地址的关系。一个用户可以有多个地址,所以是一对多的关系。以下是 u......
Perl POD 文档
Perl 中可以在模块或脚本中嵌入 POD(Plain Old Documentation) 文档。POD 是一种简单而易用的标记型语言(置标语言)。POD 文档使用规则:POD 文档以 =head1 开始, =cut 结束, =head1 前与 =cut 后添加一空行。Perl 会忽略 POD 中......
Ruby 方法
Ruby 方法与其他编程语言中的函数类似。Ruby 方法用于捆绑一个或多个重复的语句到一个单元中。方法名应以小写字母开头。如果您以大写字母作为方法名的开头,Ruby 可能会把它当作常量,从而导致不正确地解析调用。方法应在调用之前定义,否则 Ruby 会产生未定义的方法调用异常。语法def metho......
Perl 面向对象
Perl 中有两种不同地面向对象编程的实现:一是基于匿名哈希表的方式,每个对象实例的实质就是一个指向匿名哈希表的引用。在这个匿名哈希表中,存储来所有的实例属性。二是基于数组的方式,在定义一个类的时候,我们将为每一个实例属性创建一个数组,而每一个对象实例的实质就是一个指向这些数组中某一行索引的引用。在......
Python3 运算符
本章节主要说明Python的运算符。举个简单的例子 4 +5 = 9 。 例子中, 4 和 5 被称为 操 作数,”+ “ 称为运算符。Python语言支持以下类型的运算符:算术运算符比较(关系)运算符赋值运算符逻辑运算符位运算符成员运算符身份运算符运算符优先级接下来让我们一个个来学习Python的......
Java rint() 方法
rint() 方法返回最接近参数的整数值。语法该方法有以下几种语法格式:double rint(double d)参数double 原始数据类型。返回值返回 double 类型数组,是最接近参数的整数值。实例实例public class Test{ public static void mai......
MySQL PHP语法
MySQL 可应用于多种语言,包括 PERL, C, C++, JAVA 和 PHP。 在这些语言中,Mysql在PHP的web开发中是应用最广泛。在本教程中我们大部分实例都采用了 PHP 语言。如果你想了解 Mysql 在 PHP 中的应用,可以访问我们的 PHP教程。PHP提供了多种方式来访问和......
Ruby CGI方法
以下为CGI类的方法列表:序号方法描述 1CGI::new([ level=”query”]) 创建 CGI 对象。query可以是以下值: query: 没有 HTML 生成输出 html3: HTML3.2 html4: HTML4.0 Strict html4Tr: HTM......
Ruby 变量
/ruby/ruby-variable.html变量是持有可被任何程序使用的任何数据的存储位置。Ruby 支持五种类型的变量。一般小写字母、下划线开头:变量(Variable)。$ 开头:全局变量(Global variable)。@ 开头:实例变量(Instance variable)。@@ 开头......
Perl 格式化输出
Perl 是一个非常强大的文本数据处理语言。Perl 中可以使用 format 来定义一个模板,然后使用 write 按指定模板输出数据。Perl 格式化定义语法格式如下:format FormatName =fieldlinevalue_one, value_two, value_threefie......
Python3 XML解析
什么是 XML?XML 指可扩展标记语言(eX tensible M arkup Language),标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。 你可以通过本站学习 XML 教程XML 被设计用来传输和存储数据。XML 是一套定义语义标记的规则,这些标记将文档分成许多部......
MongoDB 简介
什么是MongoDB ?MongoDB 是由C++语言编写的,是一个基于分布式文件存储的开源数据库系统。在高负载的情况下,添加更多的节点,可以保证服务器性能。MongoDB 旨在为WEB应用提供可扩展的高性能数据存储解决方案。MongoDB 将数据存储为一个文档,数据结构由键值(key=>va......
Java 运算符
计算机的最基本用途之一就是执行数学运算,作为一门计算机语言,Java也提供了一套丰富的运算符来操纵变量。我们可以把运算符分成以下几组:算术运算符关系运算符位运算符逻辑运算符赋值运算符其他运算符算术运算符算术运算符用在数学表达式中,它们的作用和在数学中的作用一样。下表列出了所有的算术运算符。表格中的实......
取消
感谢您的支持,我会继续努力的!
扫码支持
扫码打赏,你说多少就多少

打开支付宝扫一扫,即可进行扫码打赏哦

您的支持,是我们前进的动力!