Algoritmos y Programación en Pascal

70 Capítulo 5. Primeros programas completos
razón para que los programas sean claros es que un programa se escribe una vez,
pero se lee muchas, bien para depurar sus posibles errores o para efectuar en
él modificaciones. Se ha dicho que un programa bien escrito debe poderse leer
tan fácilmente como una novela y, aunque esto puede resultar excesivo a veces,
conviene esmerarse desde el principio en intentarlo antes incluso que perseguir
la eficiencia.
En este sentido, conviene indicar que, de cara a mejorar la legibilidad de un
programa, también es esencial una buena estructuración y organización de las
acciones que lo componen, como se explica en los capítulos 6 y 7.
En la documentación de un programa se pueden observar, entre otros, los
aspectos siguientes:
• El sangrado o encolumnado, 1 facilitando la identificación de fragmentos
con distinto cometido o subordinados a otros, etc.
• Los comentarios, aclarando los siguientes detalles:
– El cometido de los objetos introducidos.
– El funcionamiento del programa.
– Las condiciones requeridas o garantizadas en un determinado punto
del programa. A este respecto, véase el apartado 5.4.
• La elección adecuada de identificadores, de forma que reflejen su contenido.
Las siguientes indicaciones contribuyen a su rápida interpretación:
– Como las constantes, variables y funciones representan objetos, suelen
nombrarse con sustantivos (Pi, x, sucesor) o sintagmas nominales
(MaxInt máximo entero), excepto cuando representan valores
lógicos, en que desempeñan el papel de sentencias (esPrimo es
primo), posiblemente abreviadas (primo, Odd, ok, EoLn).
– Los procedimientos representan acciones, por lo que se les suele nombrar
con verbos en infinitivo (Escribir, Write)
Por otra parte, no debe escatimarse la longitud de los identificadores (aunque
tampoco debe abusarse), cuando ello aclare el objeto identificado
(AreaTotal, PagaExtra, DistTierraSol) incluso usando varias palabras
para ello. En este caso, resulta aconsejable escribir con mayúscula la inicial
de cada palabra. Esta recomendación es válida para los identificadores
predefinidos (WriteLn, SqRt).
1 En algunos manuales puede leerse “indentado”, palabra que no existe en castellano.