¿Tiene Perl algo así como Java/PHP Docs?

Question

¿Perl tiene un generador de Perl Docs? ¿Algo como Java Docs o PHP Documenter?

Answer 1

Sí, se llama perldoc

, se escribe en la documentación de la fuente, al igual que con javadoc.

En pocas palabras, "= elemento" es un elemento con viñetas, p. Ej. una función o un parámetro "= over" baja un nivel de identación, "= back" sube un nivel. Use "= cut" donde quiere volver al código perl.

Aquí es un ejemplo de lo que podría parecer:

=item $b->add_module (%options) 

Initialize a module. A module is a repository or a branch of a repository. 
Valid options are 

=over 

=item id 

Id of this module 

=item repo 

Url of repository. Currently only subversion repositories are supported. 

=back 

=cut 
sub add_module($%) 
{ 

Basta con pasar el código de Perl a través del programa perldoc para obtener la documentación con formato.

Answer 2

¿Quiere decir perldoc?

Véase también esta relacionada con el desbordamiento de pila quesion:

• What’s the best way to document Perl code?

Answer 3

Por qué, sí. Sí, lo hace! Perldoc.

Answer 4

[solo para usuarios de Google] Como ya se ha dicho, usted crea documentación con POD (no comentarios, comentarios son para mantenedores, pod para documentación del usuario). Normalmente agrega su POD al inicio y al final de su secuencia de comandos o módulo, y antes de cada método), luego puede usar perldoc your_module en la consola, o pod2html para convertir a html y navegar en un servidor, o use pdoc (es un un poco viejo, pero es muy útil cuando se quiere tener un navegador web de documentos y enlaces al código en la web).

hay una nueva pregunta sobre el formato de la vaina que podría ser también de su interés perl-documentation-pod-browsers

y éste how-can-i-generate-html-documentation-for-perl-code-comments

Y había otro hablando de hacer un pod2html y el uso de un archivo CSS para imitar las páginas de cpansearch, pero no puedo encontrarlo ahora.