Nos centramos en especificar en las primeras dos teóricas, en demostrar la corrección de un algoritmo en las siguientes tres teóricas y ahora nos centraremos en implementar.
Buenas prácticas
1. Usar nombres declarativos
Usar nombres que revelen la intención de los elementos nombrados.
2. Indentación
- Indentar siempre al abrir un nuevo bloque.
- Ser consistente con la ubicación de llaves de apertura y finalización de ciclos y funciones.
3. Comentarios
Los comentarios no arreglan mal código. No abusar de su uso. Si lo que tengo que decir lo puedo expresar en código no necesito explicitarlo en un comentario. Los comentarios son útiles para:
- Explicitar la intención del programador
- Explicitar precondiciones o suposiciones
- Clarificar código que a primera vista puede no ser claro
4. Variables:
-
Inicialización
Es una buena práctica inicializar siempre las variables al declararlas.
-
Scope de la declaración
Usar el scope más pequeño posible.
5. Funciones
Las funciones debe ser pequeñas.
- Encapsular dentro de funciones auxiliares.
- Regla fundamental: Cada función debe...
- hacer sólo una cosa
- hacerla bien
- ser el único componente del programa encargado de esa tarea particular
- Las funciones no deben tener efectos colaterales. En particular el uso de variables globales debe ser particularmente cuidado.
6. Formato vertical
- Los archivos del proyecto no deben ser demasiado grandes.
- Conceptos relacionados deben aparecer verticalmente cerca.
- Las funciones más importante deben estar en la parte superior, seguidas de las funciones auxiliares.
- Siempre la función llamada debe estar debajo de la función llamadora.
- Las funciones menos importantes deben estar en la parte inferior del archivo.
7. Modularización
- Cada archivo del proyecto debe tener código homogéneo y relacionado con un concepto o grupo de conceptos coherentes.