Documentation POD Perl

En Perl, les documents POD (Plain Old Documentation) peuvent être intégrés dans des modules ou des scripts.

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

Règles d'utilisation des documents POD :

Les documents POD commencent par=head1début,=cutfin,=head1Avant et après=cutajoutez une ligne vide.

Perl ignore la documentation dans POD. L'exemple suit :

Exemple

#!/usr/bin/perl print "Hello, World\n"; =head1Exemple Hello, World Ceci est un simple exemple Perl.=cut print "Hello, Example\n";

L'exécution du programme ci-dessus produit la sortie suivante :

Hello, World
Hello, Example

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

Exemple

#!/usr/bin/perl print "Hello, World\n"; while(<DATA>){ print $_; } __END__ =head1Exemple Hello, World Ceci est un simple exemple Perl. print "Hello, Example\n";

L'exécution du programme ci-dessus produit la sortie suivante :

Hello, World

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

L'exemple suivant ne lit pas la documentation POD :

Exemple

#!/usr/bin/perl print "Hello, World\n"; __END__ =head1Exemple Hello, World Ceci est un simple exemple Perl. print "Hello, Example\n";

L'exécution du programme ci-dessus produit la sortie suivante :

Hello, World

Qu'est-ce que POD ?

Pod (Plain Old Documentation) est un langage de balisage simple et facile à utiliser, souvent utilisé pour écrire de la documentation dans les programmes et modules Perl.

Les convertisseurs Pod peuvent convertir Pod en de nombreux formats, tels que text, html, man, et bien d'autres.

Le langage de balisage Pod contient trois types de base : ordinaire, verbatim et commande.

Paragraphe ordinaire: Vous pouvez utiliser des codes de mise en forme dans les paragraphes ordinaires, tels que gras, italique, ou style code, souligné, etc.
Paragraphe verbatim: Les paragraphes verbatim sont utilisés pour les blocs de code ou d'autres parties qui n'ont pas besoin d'être traités par le convertisseur, et ne nécessitent pas de reflow de paragraphe.
Paragraphe de commande: Les paragraphes de commande affectent l'ensemble du document, généralement utilisés pour les paramètres de titre ou les marqueurs de liste.
Tous les paragraphes de commande (ils ne font qu'une seule ligne) commencent par "=" suivi d'un identifiant. Le texte suivant sera affecté par cette commande. Les commandes largement utilisées incluent maintenant
```
=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 :

Exemple

=beginhtml =encoding utf-8 =head1 Rookie Tutorial=cut

pod2html copiera ce code verbatim.

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

$ pod2html test.pod > test.html

Ouvrez test.html dans un navigateur, la section des liens est l'index, affiché comme suit :

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

=begin html
=encoding utf-8

<h1>Example</h1>
<p> www.example.com </p>

=end html

pod2html copiera ce code verbatim.

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

$ pod2html test.pod > test.html

Ouvrez test.html dans un navigateur, la section des liens est l'index, affiché comme suit :

Autres extensions