next up previous contents index practicapracticaPP2moodleLHPmoodlepserratacpanmodulospauseperlgoogleetsiiullpcgull
Sig: Texto verbatim Sup: Módulos Ant: Construcción de un Módulo Err: Si hallas una errata ...


La Documentación en Perl

La documentación en Perl se hace en formato pod (plain old documentation). Esta documentación se inserta en nuestro programa. Se trata de un lenguaje de marcas. Las líneas 25 a 69 en el ejemplo de la sección 6.12 muestran el uso de pod. Cuando Perl encuentra una línea que comienza con un signo igual, ignora todas las líneas hasta encontrar una línea que comienze con =cut.

Existe un buen número de utilidades que permiten pasar de formato pod a casi cualquier formato: pod2html, pod2man, pod2latex, pod2ps, pod2text, pod2pdf.pl, etc. Un traductor pod-to-XXX lee un fichero en formato pod párrafo por párrafo y lo traslada al formato XXX. Por ejemplo, para convertir a LATEX la documentación de perlpod puedes escribir algo como:

pod2latex -full /usr/share/perl/5.6.1/pod/perlpod.pod

Si se ha instalado la documentación de Perl en tu sistema, puedes acceder a ella utilizando info, man o perldoc. La orden man perl te mostrará las diferentes secciones existentes y sobre que tratan. Asi man perlboot te introducirá en la programación orientada a objetos en Perl.

Para saber mas sobre el lenguaje de marcas pod escribe man perlpod.

Un documento POD consiste de párrafos separados por líneas en blanco. Existen tres tipos de párrafos: verbatim, comandos y texto.



Subsecciones
next up previous contents index practicapracticaPP2moodleLHPmoodlepserratacpanmodulospauseperlgoogleetsiiullpcgull
Sig: Texto verbatim Sup: Módulos Ant: Construcción de un Módulo Err: Si hallas una errata ...
Casiano Rodríguez León
2006-02-21