Présentation

Le format POD^7.1 a été conçu par Larry Wall afin de faciliter la documentation des modules et programmes perl. Un de ses énormes avantages est qu'il peut être inséré à l'intérieur même du code perl, ce qui fournit une documentation automatique - et souvent plus à jour - des modules en particulier. Le but de ce langage est de fournir aux programmeurs un moyen simple d'écrire de la documentation.

Un ensemble de convertisseurs est disponible pour convertir ce format POD en d'autres formats : nroff avec pod2man pour l'affichage dans les terminaux, texte avec pod2txt pour la lecture simple, L^ATEX avec pod2tex pour obtenir une impression de qualité, HTML avec pod2html, etc. Le document au format POD lui-même ne nécessite pas d'éditeur particulier. Comme pour les programmes perl, un simple éditeur de texte suffit.

Le programme perldoc cherche dans les modules de perl celui qui correspond à l'argument qui a été passé, et en extrait la documentation.

La documentation du format est disponible, au format POD bien sûr, en exécutant la commande perldoc perlpod.

suivant: Syntaxe monter: Le format de documentation précédent: Le format de documentation Index

Olivier Aubert
1999-06-01