La documentación antigua simple ( eng. Documentación antigua simple , abreviada como pod ; de significado cercano a la expresión rusa original: "Buena documentación antigua") es un lenguaje de marcado simple que se utiliza para documentar el lenguaje de programación Perl .
Pod está diseñado para ser un lenguaje simple y limpio con una sintaxis útil mínima. Excluye intencionalmente mecanismos para describir fuentes, imágenes, colores o tablas. Aunque Pod no es tan expresivo como lenguajes como XML o LaTeX , los autores han sacrificado deliberadamente la expresividad en aras de la simplicidad y la comodidad [1] . Los principales objetivos del desarrollo de pods son:
Este formato se describe en la página de manual de perlpod , y algunos traductores de pod se describen en las páginas de manual de pod2man , pod2html y pod2text . Aunque los autores del manual de perlpod señalan que las capacidades de un pod probablemente no sean suficientes para escribir libros sobre él [2] , de hecho, hay libros escritos en una versión extendida del pod. Esta versión extendida incluye características para el formato de tablas y notas al pie y ha sido utilizada por O'Reilly & Associates para producir varios libros sobre Perl (el más famoso Programación en Perl [1] por Larry Wall , Tom Christiansen y John Orvant). Otra versión extendida de pod, llamada mod, se usó en el libro Perl de en:Higher-Order de Mark Jason Dominus.
Puede leer la documentación de POD formateada integrada en el programa utilizando la utilidad de visor suministrada:
% perldoc program_with_pod % perldoc perlpodAdemás, la documentación de POD es muy fácil de leer al mirar el código fuente de un módulo.
Una descripción en formato POD se puede convertir en una página web con la utilidad perl:
%pod2html --outfile = program.html programa_con_podPara convertir la documentación a formato de texto sin formato, puede utilizar:
pod2text nombre de archivo.pm > nombre de archivo.txt
Documentación POD agregada al final del archivo:
#!/usr/local/bin/perl hola (); sub hola { print "¡Hola mundo!\n" ; } __FINAL__ # Cadena en blanco requerida =head1 NOMBRE # Nombre del programa o módulo =head1 SINOPSIS # Una línea que describe lo que hace el módulo o programa =head1 DESCRIPCIÓN # Matriz de documentación =head1 AUTOR # Quién es usted =head1 ERRORES # Qué salió mal =head1 VER TAMBIÉN # Información Adicional| Lenguajes de marcado de documentos | |
|---|---|
documentos de oficina | |
| bien conocido | |
| menos conocido |
|