POD :: Plantilla POD :: La plantilla es un módulo PERL para construir la documentación de la POD de las plantillas.
Descargar ahora

POD :: Plantilla Clasificación y resumen

POD :: Plantilla Etiquetas

Módulo perl edificio VAINA documentación pod Documentación de plantillas

POD :: Plantilla Descripción

POD :: La plantilla es un módulo PERL para construir la documentación de la POD desde las plantillas. POD :: La plantilla es un módulo PERL para la documentación de la POD de construcción de las plantillas.Synopsis ### Como módulo ### Use POD :: plantilla; My $ PARSER = NUEVO POD :: Plantilla; $ parser-> analizar (plantilla => 'documentation.ptmpl'); Imprimir $ parser-> as_string ### Como script ### $ PODTMPL -I DIR1 -I DIR2 Documentation.ptmpl ### Un módulo simple preparado para usar POD :: Plantilla ### Paquete My :: Module; = Plantilla print_me = head2 print_me ($ string) imprime su argumento. = Cortar Sub Print_me {Imprimir Shift; Devolver 1} ### Un archivo de POD simple llamado Extra / ADICIONAL.POD ### = POD = Plantilla retorn_vals Esta subrutina devuelve 1 para el éxito y el UNDEF para el fracaso. = Cortar ### A simple :: plantilla de plantilla ### = incluir mi :: módulo = incluir extra / adicionales.pod como extra = pod = synopsis de cabeza 1 :: módulo My :: Module :: print_me ('algunos texto'); = Funciones de Head2 = Insertar mi :: Module-> Print_me = Insertar extra-> return_vals = Documentación de la escritura en un proyecto Mantenido por varias personas que abarca más de un módulo es un asunto difícil. Hay muchas cosas a considerar: ubicaciones, debe estar en línea (por encima de cada función), en la parte inferior del módulo, o en un archivo distinto? El primero es más fácil para los desarrolladores, pero los dos últimos son mejores para los mantenedores de la podación. ¿Qué orden debe estar en la documentación? ¿Pertenece en el orden en que se escriben las funciones, o ordenadas por otro principio, como la frecuencia de uso o el tipo de función? Nuevamente, la primera opción es mejor para los desarrolladores, mientras que los dos segundos son mejores para el usuario.Referenceshow ¿Debe mencionarse una función en otro archivo? ¿Debería la documentación simplemente decir 'ver otro :: módulo', o debería incluir la sección correspondiente? La duplicación significa que la documentación es más probable que esté desactualizada, pero es malo que un usuario tenga que leer numerosos documentos para simplemente averiguar qué método heredado sí. MEADERS y pies de página ¿Qué deben hacerse con encabezados y pies de página estándar? Si se les pegan a cada archivo, o se puede asumir el archivo principal para cubrir todo el proyecto? Pod :: Plantilla ofrece una solución a estos problemas: la documentación se construye desde plantillas. Requisitos: · Perl

POD :: Plantilla Software relacionado