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 (langage de balisage).
Règles d'utilisation des documents POD :
Le document POD commence par =head1 et se termine par =cut . Ajoutez une ligne vide avant =head1 et après =cut .
Perl ignore la documentation dans les POD. Les exemples sont les suivants :
En exécutant le programme ci-dessus, le résultat de sortie est :
Bonjour le mondeBonjour Codercto
Nous pouvons également utiliser « __END__ » ou « __DATA__ » pour « commenter » tout le contenu après la ligne :
En exécutant le programme ci-dessus, le résultat de sortie est :
Bonjour, Monde=head1 Bonjour, Monde Exemple Ceci est un exemple Perl simple. print "Bonjour, Codercton" ;
L'exemple suivant ne lit pas le document POD :
En exécutant le programme ci-dessus, le résultat de sortie est :
Bonjour le monde
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 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, textuel et commande.
Paragraphes ordinaires : vous pouvez utiliser des codes de formatage dans les paragraphes ordinaires, tels que le gras, l'italique ou le style de code, le soulignement, etc.
Paragraphe d'origine : paragraphe d'origine, 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 : les paragraphes de commande agissent sur l'ensemble du document et sont généralement utilisés pour la définition du titre ou le balisage de liste.
Tous les paragraphes de commande (qui ne comportent 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 (document de début)=head1 title text=head2 title text=head3 title text=head4 title text=plus d'espaces indentés=item prefix=back (fin de liste)=begin document format=fin end document format=pour formater le texte =encodage type d'encodage=couper (fin du document)
En perl, vous pouvez utiliser pod2html **.pod >**.html pour générer des documents pod au format html.
Considérez l'instance POD suivante :
Lorsque pod2html est utilisé, ce code sera copié du texte original.
Utilisez la commande pod2html pour l'exécuter et le 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=encodage utf-8<h1>Tutoriel Codeur</h1><p> www.codercto.com </p>=fin html
Lorsque pod2html est utilisé, ce code sera copié du texte original.
Utilisez la commande pod2html pour l'exécuter et le 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 :