documentazione Perl POD

Perl può essere integrato POD (Plain Old Documentation) nella documentazione del modulo o dello script.

POD è un semplice e facile da usare il linguaggio basato su tag (linguaggio di marcatura).

documentazione POD utilizzando le regole:

documentazione POD comincia con= head1, =finetagliare,e prima= head1= tagliato dopo l'aggiunta di una riga vuota.

Perl ignora la documentazione POD. Esempi sono i seguenti:

#!/usr/bin/perl

print "Hello, World\n";

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

print "Hello, w3big\n";

Il programma precedente, l'uscita è:

Hello, World
Hello, w3big

Possiamo anche usare "__END__" o "__DATA__", dopo il contenuto della linea in cui tutti i "Commenti" fuori:

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

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

Il programma precedente, l'uscita è:

Hello, World

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

Gli esempi che seguono non vengono lette documentazione POD:

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

Il programma precedente, l'uscita è:

Hello, World

Che cosa è POD?

Pod (Plain Old Documentation), è un semplice e facile da usare il linguaggio basato su tag (markup language), è spesso usato nei programmi Perl e moduli scritti nel documento.

conversione Pod Pod può essere convertito in una varietà di formati, come testo, HTML, uomo molto e così via.

Pod marcatura è costituito da tre tipi fondamentali di base: normale, originali, e comandi.

• paragrafo normale: È possibile utilizzare i codici di formattazione ai punti comuni, come grassetto, corsivo, o lo stile di codifica, sottolineare.

• paragrafo originale: passaggi di testo, per una parte del blocco di codice o di altre lavorazioni convertitore non è necessario, ma non richiede il paragrafo riarrangiamento.

• il comando Paragrafo: Comando ruolo Paragrafo nell'intero documento o un elenco di comunemente usato per impostare i tag del titolo.

  Tutti i paragrafi di comando (il suo unico della lunghezza della linea) utilizzando i "=" e poi è un identificatore. testo successivo sarà influenzato da questo Ordine. Command è ora ampiamente utilizzato includere

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

In Perl, è possibile utilizzare pod2html **. Pod> **. Html per generare un formato pod documento HTML.

POD Considerare i seguenti esempi:

=begin html
=encoding utf-8

=head1 本教程

=cut

Questo codice sarà la copia originale quando pod2html.

Utilizzare pod2html eseguire il comando per convertirlo in codice HTML:

$ pod2html test.pod > test.html 

Aprire il test.html del browser, collega la sezione per l'indice, è la seguente:

I seguenti esempi vengono scritti direttamente nella documentazione HTML POD:

=begin html
=encoding utf-8

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

=end html

Questo codice sarà la copia originale quando pod2html.

Utilizzare pod2html eseguire il comando per convertirlo in codice HTML:

$ pod2html test.pod > test.html 

Aprire il test.html del browser, collega la sezione per l'indice, è la seguente: