Decálogo

Guía del Programador C

En general, es sumamente importante tener un método o guía que dirija la tarea del programador. Si cabe, en el caso del C esto es aún más importante. Por tanto, se recomienda proceder en el orden siguiente:

1. Definir un archivo .h (o los que sean necesarios) con las constantes y cabeceras de las funciones que se van a escribir. En el ejemplo inicial es el archivo imprimir.h
2. En cada archivo fuente del programa comenzar escribiendo el esqueleto de las funciones que se pide programar. Esqueleto significa la definición de la función y el código necesario (return) acorde con el tipo de dato que devuelve la función de tal modo que, aunque no haga nada útil, compile sin avisos ni errores
3. El cuerpo de la función puede estar vacío o, opcionalmente, puede imprimir los valores de los argumentos. En todo caso se trata de una versión mínima para atender al paso siguiente
4. No es aconsejable mezclar el código del programa y el de pruebas en el mismo archivo fuente. Este último se debe escribir en un programa de prueba (tester) que procese los argumentos en la línea de orden de modo que al menos exista una opción para probar individualmente cada una de las funciones que se pide programar
5. Compilar primero todos los fuentes que componen el programa tester con las opciones más restrictivas, normalmente serán -Wall -Wextra -ansi -pedantic -Werror. No pasar de aquí hasta que todos los esqueletos compilen 🆗
6. Compilar siempre todos los fuentes que componen el programa con las opciones de compilación más restrictivas, normalmente serán -Wall -Wextra -ansi -pedantic -Werror. No pasar de aquí hasta que todos compilen 🆗
7. Si se trata de un programa que debería ejecutarse en otro sistema, por ejemplo en Triqui, llevar todos los ficheros y comprobar que compila y funciona también en dicho sistema
8. Es importante destacar que, idealmente, a partir de aquí únicamente procede modificar el código de nuestro programa. No obstante, lo más frecuente es tener que modificar también el tester para incorporar nuevas pruebas del programa. Por lo tanto, para ahorrar tiempo y minimizar errores es conveniente automatizar las tareas tanto como sea posible. Por ejemplo, escribiendo un shell script responsable de la compilación
9. Completar, compilar y probar el código de las funciones en cada uno de los ficheros fuentes que componen el programa completo
10. Por último pero no menos importante, la legilibilidad del código es fundamental. En el caso ideal el propio código es la mejor documentación posible del programa. Por ende, no basta con que el programa funcione sino que debe tener una estructura y modularidad suficientes para que sea comprensible