normas de estilo

Estilo de codificación en Picky para Programación
Francisco J Ballesteros
Enrique Soriano
Gorka Guardiola
Es importante seguir ciertas normas a la hora de escribir programas. Hacerlo supone cometer menos
errores y, lo que es más importante, encontrar los errores antes cuando se cometen.
En la vida real cada programador es el primer interesado en mantener un estilo de programación
coherente con el proyecto en que trabaja. En esta asignatura emplearemos el estilo demostrado por los programas suministrados por el profesor de la asignatura. No obstante, detallamos aquí las normas.
No seguir las normas de estilo puede suponer desde una reducción de la nota hasta un
suspenso.
1
Ante todo, el código ha de ser claro. Las expresiones no deben anidarse en exceso y las líneas no han
de ser muy largas. El código de las funciones y procedimientos tampoco ha de ser excesivamente
largo.
2
Idealmente cada función o procedimiento debe tener los identificadores nombrados de tal modo que
resulte obvio lo que hace cada función o procedimiento. Si esto no es así, hay que escribir un comentario de una o dos líneas antes de cada subprograma que aclare lo que hace.
3
Los nombres de funciones deben corresponder al objeto calculado.
4
Los nombres de procedimientos deben corresponder a la acción efectuada.
5
Las palabras clave del lenguaje se escriben en minúsculas.
6
Los nombres de los tipos de datos y constantes se capitalizan como TipoColorPrimario.
6
Los nombres de programa, procedimientos y funciones se escriben en minúsculas, como
ordenarlista.
7
Los nombres de los tipos de datos para punteros deben empezar por TipoPtr o TipoLista.
8
Los nombres de las variables de tipo puntero han de empezar por la letra p.
9
Los nombres de variables se capitalizan en minúscula.
10
Debería emplearse el nombre más corto que haga obvio su significado.
11
Sólo se permite declarar una variable por línea.
12
No se permite inicializar variables en la declaración. (Las constantes si, por supuesto).
13
Las distintas declaraciones del programa deben realizarse en el orden utilizado en los programas suministrados en clase (comentario para el programa; cabecera del mismo; declaración de tipos y constantes universales; instanciación de paquetes auxiliares; subprogramas; constantes de prueba; cuerpo
del programa principal, incluyendo ejecución de pruebas y el programa propiamente dicho).
14
No se permiten sentencias return salvo al final de una función.
15
El programa debe estar correctamente tabulado siguiendo el estilo utilizado en clase y hay que
emplear tabuladores (el tabulador debe estar configurado con un ancho de 8 caracteres).