• Publicidad

Insertar documentación

¿Apenas comienzas con Perl? En este foro podrás encontrar y hacer preguntas básicas de Perl con respuestas aptas a tu nivel.

Insertar documentación

Notapor jmdelcampo » 2008-08-25 02:13 @134

Buenos días,

Necesito documentar un script Perl de modo que cuando el usuario escriba en línea de comando man nombre_script aparezca información con los parámetros de entrada del script del mismo modo que con cualquier comando UNIX.

¿Es necesario instalar algún módulo? ¿Cómo lo puedo hacer?

Saludo y muchas gracias
jmdelcampo
jmdelcampo
Perlero nuevo
Perlero nuevo
 
Mensajes: 32
Registrado: 2006-11-24 07:43 @363

Publicidad

Notapor explorer » 2008-08-25 04:42 @237

Te recomiendo que lo hagas con el sistema de documentación POD (Plain Old Documentation) (ver perlpod), en el propio programa.

Una vez hecho ésto, podrás ver la documentación con el comando perldoc. Con ese mismo comando podrás generarla en distintos formatos (man, HTML, Latex...).

En CPAN encontrarás muchas más aplicaciones para la documentación POD.
JF^D Perl programming & Raku programming. Grupo en Telegram: https://t.me/Perl_ES
Avatar de Usuario
explorer
Administrador
Administrador
 
Mensajes: 14480
Registrado: 2005-07-24 18:12 @800
Ubicación: Valladolid, España

Notapor jmdelcampo » 2008-08-25 05:33 @272

Gracias Explorer
jmdelcampo
Perlero nuevo
Perlero nuevo
 
Mensajes: 32
Registrado: 2006-11-24 07:43 @363

Notapor jmdelcampo » 2008-08-28 01:24 @100

Hola de nuevo,

Una vez escrita la información en el script, ¿cómo la puedo visualizar? ¿Qué comandos tengo que ejecutar?

Saludos y gracias
jmdelcampo
jmdelcampo
Perlero nuevo
Perlero nuevo
 
Mensajes: 32
Registrado: 2006-11-24 07:43 @363

Notapor explorer » 2008-08-28 04:11 @216

Ya te he comentado antes... el comando perldoc.

Ejemplo, con el siguiente programa:
Sintáxis: [ Descargar ] [ Ocultar ]
Using perl Syntax Highlighting
#!/usr/bin/perl
use strict;
use warnings;
use diagnostics;

=pod

=head1 Programa para ver el máximo de un fichero

Esto es una prueba

=cut



my $maximo = 1;

while (my $linea = <DATA>) {

    my ($palabra) = split(" ", $linea);

    if ($palabra > 0) {
        $maximo = $palabra
            if $maximo < $palabra;
    }

    print $linea;
}

print $maximo+1, "\n";

__DATA__
Coloreado en 0.002 segundos, usando GeSHi 1.0.8.4
Con el comando perldoc kk.pl
Código: Seleccionar todo
KK(1)                 User Contributed Perl Documentation                KK(1)



Programa para ver el máximo de un fichero
       Esto es una prueba



perl v5.8.8                       2008-08-28                             KK(1)
JF^D Perl programming & Raku programming. Grupo en Telegram: https://t.me/Perl_ES
Avatar de Usuario
explorer
Administrador
Administrador
 
Mensajes: 14480
Registrado: 2005-07-24 18:12 @800
Ubicación: Valladolid, España


Volver a Básico

¿Quién está conectado?

Usuarios navegando por este Foro: No hay usuarios registrados visitando el Foro y 1 invitado