Documentation Perl POD


Perl peut intégrer des documents POD (Plain Old Documentation) dans des modules ou des scripts.

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

Règles d'utilisation des documents POD :

Le document POD commence par =head1, =cut se termine par =head1<🎜 Ajoutez une ligne vide avant et après =cut.

Perl ignore la documentation dans POD. L'exemple est le suivant : 

#!/usr/bin/perl

print "Hello, World\n";

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

print "Hello, php\n";

Exécutez le programme ci-dessus, le résultat de sortie est : 

Hello, World
Hello, php

Nous pouvons également utiliser "__END__" ou "__DATA__" pour "commenter" tout le contenu après la ligne : 

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

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

Exécutez le programme ci-dessus, le résultat de sortie est :

Hello, World

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

L'exemple suivant ne lit pas le document POD :

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

Exécutez le programme ci-dessus, le le résultat de sortie est :

Hello, World

Qu'est-ce que le POD ?

Pod (Plain Old Documentation), est un langage de balisage (langage de balisage) simple et facile à utiliser, qui est souvent utilisé pour l'écriture de documents dans les programmes et modules Perl.

Le convertisseur de Pod peut convertir Pod dans de nombreux formats, tels que texte, html, man, etc.

Le langage de balisage Pod contient trois types de base : normal, original et commande.

  • Paragraphe normal : Vous pouvez utiliser des codes de formatage dans les paragraphes normaux, tels que le caractère gras, l'italique ou le style de code, le soulignement, etc.

  • Paragraphe original  : paragraphe original, utilisé pour les blocs de code ou d'autres parties qui ne nécessitent pas de traitement de convertisseur et ne nécessitent pas de réarrangement de paragraphe.

  • Paragraphe de commande  : Le paragraphe de commande agit sur l'ensemble du document, généralement utilisé pour la définition du titre ou le balisage de liste.

    Tous les paragraphes de commande (qui ne font qu'une seule ligne) commencent par "=", suivi d'un identifiant. Le texte suivant sera affecté par cette commande. Les commandes désormais largement utilisées incluent 

    =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 des documents pod au format html.

Considérez l'exemple POD suivant : 

=begin html
=encoding utf-8

=head1 php中文网

=cut

Lorsque pod2html est utilisé, ce code sera copié à partir du texte original.

Utilisez la commande pod2html pour l'exécuter et la convertir en code HTML : 

$ pod2html test.pod > test.html

Ouvrez test.html dans le navigateur, la partie lien est l'index, comme indiqué ci-dessous :

L'exemple suivant écrit du HTML directement dans le document POD :

=begin html
=encoding utf-8

<h1>php中文网</h1>
<p> www.php.cn </p>

=end html

pod2html copiera le texte original de ce code.

Utilisez la commande pod2html pour l'exécuter et la convertir en code HTML : 

$ pod2html test.pod > test.html

Ouvrez test.html dans le navigateur, la partie lien est l'index, comme indiqué ci-dessous :

←