Estilos de codificación
- Concepto
- Denominación de identificadores
- Documentación del código
- Declaraciones
- Sentencias
- Entradas y salidas
- Eficiencia
Concepto
En relación a cualquier actividad humana
puede decirse que existe un estilo cuando:
El grado de semejanza entre las diversas actitudes, planteamientos y actuaciones de una persona,
o de un grupo de personas, es tal que es posible identificar esta semejanza y deducir esquemas
generales de comportamiento.
- Todo programador termina por desarrollar su propio estilo de codificación
- Puede llegar a ser posible identificar, a través de su estilo de codificación, al autor de un programa
- Hay aspectos positivos y negativos en los diversos estilos posibles
- Es posible mejorar el estilo de codificación propio, y también adoptar un determinado estilo
- La homogeneización de los estilos de los programadores de un grupo facilita las labores de programación
Denominación de identificadores
D=V*T
DIST=VELHOR*TIEMPO
DISTANCIA = VELOCIDAD_HORIZONTAL*TIEMPO_TRANSCURRIDO_EN_SEG
Distancia=VelocidadHorizontal*TiempoTranscurridoEnSeg
- Podemos usar identificadores con nombres:
- cortos y poco significativos, ó
- largos y significativos;
- Se ha demostrado que el uso de nombres significativos facilita la comprensión de los programas, disminuyendo el número de errores durante el desarrollo y el mantenimiento;
- los nombres muy cortos aumentan la posibilidad de colisiones
- los nombres largos obligan a escribir más, dificultando la comprensión de las sentencias largas o complejas;
- independientemente de cual sea el tamaņo de los identificadores, es fácil cometer errores de transcripción:
- si el LP posee verificación de tipos, un error de transcripción que no de lugar a colisiones será detectado en tiempo de compilación
- los errores de transcripción disminuyen si los identificadores se declaran cerca de la zona de código en que se usan;
- el uso de variables globales aumenta las posibilidades de colisión;
Documentación del código
Contribuyen a la documentación del código:
- los comentarios
- una presentación adecuada
- la claridad de los identificadores
Los comentarios
- deben aparecer en número suficiente (tampoco demasiados)
- el peor comentario posible no es el que no está, sino el comentario
erróneo
- durante el mantenimiento deben actualizarse los comentarios
- distinguiremos entre:
- comentarios de prólogo
- comentarios en línea
Declaraciones
- caso de existir una zona de declaraciones de datos:
- esta zona debe estructurarse siguiendo alún criterio (tipos de
declaración, uso de los identificadores, ...)
- cuando en una línea se declaran varios identificadores pueden
ordenarse alfabéticamente p.e.
- en la medida de lo posible, acercar las declaraciones y la zona de
código en que se usan
- documentar las declaraciones de estructuras complejas
Sentencias