En Perl, los documentos POD (Plain Old Documentation) se pueden incrustar en módulos o scripts.
POD es un lenguaje de marcado (lenguaje de marcado) simple y fácil de usar.
Reglas de uso de documentos POD:
El documento POD comienza con =head1 y termina con =cut . Agregue una línea en blanco antes de =head1 y después de =cut .
Perl ignora la documentación en los POD. Los ejemplos son los siguientes:
Al ejecutar el programa anterior, el resultado de salida es:
Hola MundoHola Codercto
También podemos usar "__END__" o "__DATA__" para "comentar" todo el contenido después de la línea:
Al ejecutar el programa anterior, el resultado de salida es:
Hola, mundo=head1 Hola, mundo Ejemplo Este es un ejemplo sencillo de Perl. print "Hola Codercton";
El siguiente ejemplo no lee el documento POD:
Al ejecutar el programa anterior, el resultado de salida es:
Hola Mundo
Pod (Plain Old Documentation) es un lenguaje de marcado (lenguaje de marcado) simple y fácil de usar, que a menudo se usa para escribir documentos en programas y módulos de Perl.
El convertidor Pod puede convertir Pod a muchos formatos, como texto, html, man, etc.
El lenguaje de marcado Pod contiene tres tipos básicos: normal, textual y de comando.
Párrafos comunes : puede utilizar códigos de formato en párrafos comunes, como negrita, cursiva o estilo de código, subrayado, etc.
Párrafo original : párrafo original, utilizado para bloques de código u otras partes que no requieren procesamiento del convertidor y no requieren reorganización de párrafos.
Párrafo de comando : los párrafos de comando actúan en todo el documento y generalmente se usan para configurar títulos o marcar listas.
Todos los párrafos de comando (que tienen solo una línea) comienzan con "=", seguido de un identificador. El texto posterior se verá afectado por este comando. Ahora los comandos más utilizados incluyen
=pod (documento inicial)=texto del título del encabezado1=texto del título del encabezado2=texto del título del encabezado3=texto del título del encabezado4=número excesivo de espacios sangrados=prefijo del elemento=atrás (lista final)=formato de inicio del documento=formato del documento final=para formato de texto =codificación tipo de codificación=cortar (fin del documento)
En Perl, puede utilizar pod2html **.pod >**.html para generar documentos pod en formato html.
Considere la siguiente instancia de POD:
Cuando se utiliza pod2html, este código se copiará del texto original.
Utilice el comando pod2html para ejecutarlo y convertirlo a código HTML:
$ pod2html prueba.pod > prueba.html
Abra test.html en el navegador, la parte del enlace es el índice, como se muestra a continuación:
El siguiente ejemplo escribe HTML directamente en el documento POD:
=begin html=codificación utf-8<h1>Tutorial de codificador</h1><p> www.codercto.com </p>=end html
Cuando se utiliza pod2html, este código se copiará del texto original.
Utilice el comando pod2html para ejecutarlo y convertirlo a código HTML:
$ pod2html prueba.pod > prueba.html
Abra test.html en el navegador, la parte del enlace es el índice, como se muestra a continuación: