documentação Perl POD

Perl pode ser embutido POD (Plain Old Documentation) na documentação do módulo ou script.

POD é um simples e fácil de usar linguagem baseada em tags (linguagem de marcação).

documentação POD usando regras:

documentação de POD inicia com= head1, = cortefinal, e antes= head1= cortado depois de adicionar uma linha em branco.

Perl ignora a documentação POD. Exemplos são os seguintes:

#!/usr/bin/perl

print "Hello, World\n";

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
=cut

print "Hello, w3big\n";

O programa acima, a saída é:

Hello, World
Hello, w3big

Nós também podemos usar "__END__" ou "__DATA__" depois de o conteúdo da linha onde todos os "Comentários" para fora:

#!/usr/bin/perl

print "Hello, World\n";

while(<DATA>){
  print $_;
}

__END__

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

O programa acima, a saída é:

Hello, World

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

Os exemplos a seguir não são lidos documentação POD:

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

O programa acima, a saída é:

Hello, World

O que é POD?

Pod (Plain Old Documentação), é um simples e fácil de usar linguagem baseada em tags (linguagem de marcação), é muitas vezes usado em programas Perl e módulos escritos no documento.

conversão vagem vagem pode ser convertido numa variedade de formatos, como texto, html, homem muito e assim por diante.

Pod marcação consiste em três tipos básicos básicas: normal, original e comandos.

• parágrafo normal: Você pode usar códigos de formatação nos pontos comuns, como negrito, itálico ou estilo de codificação, sublinhado.

• parágrafo original: passagens de texto, por parte do bloco de código ou outro processamento conversor não é exigido, mas não exige parágrafo rearranjo.

• comando parágrafo: papel parágrafo Command no documento inteiro ou uma lista de comumente usado para definir as tags de título.

  Todos os parágrafos de comando (o seu único comprimento de linha), utilizando os "=" e, em seguida, é um identificador. texto subseqüente será afetado por esta ordem. Comando é agora amplamente utilizados incluem

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

Em Perl, você pode usar pod2html **. Pod> **. Html para gerar um formato pod documento html.

POD Considere os seguintes exemplos:

=begin html
=encoding utf-8

=head1 本教程

=cut

Este código será a cópia original quando pod2html.

Use pod2html executar o comando para convertê-lo ao código HTML:

$ pod2html test.pod > test.html 

Abra o navegador test.html, seção para o índice de links, é mostrado abaixo:

Os exemplos seguintes são gravados directamente no HTML documentação POD:

=begin html
=encoding utf-8

<h1>本教程</h1>
<p> www.w3big.com </p>

=end html

Este código será a cópia original quando pod2html.

Use pod2html executar o comando para convertê-lo ao código HTML:

$ pod2html test.pod > test.html 

Abra o navegador test.html, seção para o índice de links, é mostrado abaixo: