¿Hay algunas convenciones para escribir comentarios POD para Perl?

Question

yo era capaz de encontrar una página de Safari Books Online que ofrece una plantilla , pero Nunca tiene comentarios escritos POD, no estoy seguro de lo bueno que es o si no se encuentra nada que pueda ser considerado Convención que incluya.

¿Cuáles son las convenciones a seguir al escribir los comentarios POD para scripts de Perl? ¿Hay algo como convenios Javadoc de Sun , pero por los comentarios POD?

Answer 1

No es elaborar, pero me gusta introducción perlpodtut de Juerd mucho.

El autor menciona lo que él considera secciones comunes y lo que incluiría.

Answer 2

Hay una serie de recomendaciones en Perl Best Practices . Todo el capítulo 7 cubre la documentación, con el POD, y los mejores enfoques para la documentación de los módulos, grandes proyectos, etc. También habla de convenciones CPAN. Eso es probablemente su mejor apuesta.

Answer 3

Perl :: crítico ofrece las siguientes políticas:

• Perl :: :: Crítica Política :: Documentación :: PodSpelling

• Perl :: :: Crítica Política :: Documentación :: RequirePackageMatchesPodName

• Perl :: :: Crítica Política :: Documentación :: RequirePodAtEnd

• Perl :: :: Crítica Política :: Documentación :: RequirePodSections

una lista de secciones requeridas es proporcionada por la última política anterior.

módulo de arranque :: :: PBP generará el código estándar para ti.

Answer 4

Usted puede mirar en el Pod para los módulos de Perl en CPAN Buscar y rápidamente en cuenta las cosas que todo el mundo hace . Los diferentes módulos a partir herramientas hacen repetitivo para usted.

Eso es lo más cercano que obtendrá con las directrices.