📜  Perl 编程中的纯旧文本文档

📅  最后修改于: 2022-05-13 01:55:40.854000             🧑  作者: Mango

Perl 编程中的纯旧文本文档

POD 是一种标记语言,用于为 Perl、Perl 程序和 Perl 模块编写文档。使用简单。

有多种翻译器可用于将 Pod 转换为不同的格式,例如纯文本、HTML、手册页等。 Pod 标记由三种段落组成:

  • 普通段落:对于粗体、斜体、代码样式、超链接等,在普通图形中使用格式化代码
  • Verbatim Paragraph:使用代码块或其他不需要任何特殊解析或格式化的文本来实现,这些也不应该被包装。
  • 命令段落:命令段落用于文本块,通常用作标题或列表的一部分。命令段落以 = 开头,后跟标识符和任意文本

要在 Perl 模块和脚本中嵌入 Pod(纯旧文本)文档,请使用以下规则在您的 Perl 代码中使用嵌入文档:

  • 以空行开始您的文档
  • 在开头放置一个' = head1'命令
  • 在末尾放置一个 = cut”命令

例子:

=head1 SYNOPSIS
 [GEEKSFORGEEKS].
=cut

下面提到的是在 Perl 代码中使用嵌入式文档的简单示例

#!/usr/bin/perl
  
print "Hello, World\n";
  
=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
=cut
  
print "Hello, geeksforgeeks\n"

输出:

Hello, World
Hello, geeksforgeeks

如果 Pod 放在文件末尾,并且您使用__END____DATA__剪切标记,那么请确保在第一个 Pod 命令之前放置一个空行,否则在 = head1之前没有空行,许多翻译者会无法将 = head1识别为启动 Pod 块。

#!/usr/bin/perl
  
print "Hello, World\n";
  
while() {
  print $_;
}
  
__END__
  
=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, geeksforgeeks\n";

输出:

Hello, World

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, geeksforgeeks\n";