Manual de Perl (II): Antes del código

Antes de empezar a escribir código hay una serie de tareas a tener en cuenta si queremos hacerlo correctamente. Claro que podemos simplemente abrir un editor de texto, escribir algunas líneas de código y ejecutarlo; si necesitamos algo corto, rápido y dulce podría estar bien, pero si estamos escribiendo un script que vamos a usar en el futuro o que pasará a otra persona o grupo debemos seguir algunas pautas básicas y muy recomendables:

• Planear el flujo del programa
• Organizarlo para poder reutilizar partes, si es necesario
• Documentar, documentar, documentar.

Comentarios

Un comentario no es más que un texto o anotación dentro del código, el cual no es interpretado, el interprete de Perl simplemente lo ignora.
Se usa para agregar información sobre el código o secciones de éste.

Para escribir comentarios en Perl se utiliza el símbolo #. Cualquier texto después de # y hasta el final de línea es un comentario.

# Esto es un comentario

Perl no tiene marcador de comentarios multilínea, por lo que para comentar varias líneas pondremos un # al comienzo de cada una de ellas.

# Ejemplo de comentario
# multilínea.


Plantillas, un buen hábito

Una buena costumbre es realizar una plantilla que servirá de base para nuestros scripts, así conseguimos que todos los que escribimos tengan parecido y sentido consistente con la misma.
En ella deberiamos incluir información sobre quién lo escribió, cuándo, qué hace y que versión es. Además, si estamos creando cualquier subrutina en el script, también deberiamos indicar qué es lo que se debe pasar, qué se retorna y una descripción de la función.

Un ejemplo de plantilla sería:

[Encabezado del script]
#!/usr/bin/perl -w
#--------------------
#Script Name:
#Script Version:
#Date:
#Author:
#Description:
#Revision History:
# 1.0/: original version
#--------------------
[FIN Encabezado del script]


[Encabezado de función]
#--------------------
#Function
#Version Adde
#Input:
#Output:
#Description:
#--------------------
[FIN Encabezado de función]


Primera línea

La primera línea de nuestros programas debe empezar con #! y la ruta al intérprete de Perl. No siempre es necesaria pero si muy recomendable, ya que indica al programa donde debe buscar el interprete y sirve para pasarle opciones en tiempo de ejecución.
Por ejemplo, para ejecutar el script en modo Warning (y el interprete está en /usr/bin) nuestra primera línea deberia ser:

#!/usr/bin/perl -w

Esto ejecutará nuestro script activando varios warnings útiles, pero existen muchas opciones diferentes, para más información lo mejor es consultar el manual de perl.

Artículos relacionados:
Manual de Perl: Introducción