documentation Perl POD

Perl peut être intégré POD (Plain Old Documentation) dans la documentation du module ou script.

POD est un simple et facile à utiliser un langage à base de balises (langage de balisage).

documentation POD utilisant des règles:

documentation POD commence par= head1, =extrémitécoupée,et avant= head1= coupé après l' ajout d' une ligne blanche.

Perl ignore la documentation POD. Des exemples sont les suivants:

#!/usr/bin/perl

print "Hello, World\n";

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

print "Hello, w3big\n";

Le programme ci-dessus, le résultat est:

Hello, World
Hello, w3big

Nous pouvons également utiliser "__END__" ou "__DATA__" après le contenu de la ligne où tous les "Commentaires" sur:

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

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

Le programme ci-dessus, le résultat est:

Hello, World

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

Les exemples suivants ne sont pas lus documentation POD:

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

Le programme ci-dessus, le résultat est:

Hello, World

Qu'est-ce POD?

Pod (Plain Old Documentation), est un simple et facile à utiliser un langage à base de balises (langage de balisage), il est souvent utilisé dans les programmes et modules perl écrit dans le document.

conversion Pod Pod peut être converti en une variété de formats, tels que le texte, html, homme beaucoup et ainsi de suite.

Pod balisage se compose de trois types de base de base: normal, original, et les commandes.

• paragraphe normal: Vous pouvez utiliser des codes de mise en forme dans les paragraphes ordinaires, tels que gras, italique, ou le style de codage, souligné.

• paragraphe Original: des passages de texte, pour une partie du bloc de code ou un autre traitement de convertisseur est pas nécessaire, mais ne nécessite pas le paragraphe réarrangement.

• Paragraphe commande: Commande Paragraphe rôle dans le document entier ou une liste des couramment utilisé pour définir les balises de titre.

  Tous les paragraphes de commande (sa seule longueur de ligne) en utilisant les "=", puis est un identifiant. Le texte qui suit sera affectée par la présente ordonnance. Commande est maintenant largement utilisé comprennent

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

En perl, vous pouvez utiliser pod2html **. Pod> **. Html pour générer un format pod de document html.

POD Considérons les exemples suivants:

=begin html
=encoding utf-8

=head1 本教程

=cut

Ce code sera la copie lorsque pod2html originale.

Utilisez pod2html exécuter la commande pour le convertir en code HTML:

$ pod2html test.pod > test.html 

Ouvrez le test.html du navigateur, section de liens pour l'index, est indiqué ci-dessous:

Les exemples suivants sont écrits directement dans la documentation POD HTML:

=begin html
=encoding utf-8

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

=end html

Ce code sera la copie lorsque pod2html originale.

Utilisez pod2html exécuter la commande pour le convertir en code HTML:

$ pod2html test.pod > test.html 

Ouvrez le test.html du navigateur, section de liens pour l'index, est indiqué ci-dessous: