El error más común cuando generamos código es verlo como una caja negra, pensando que lo importante es «lo que hace» y no «cómo lo hace». Esto es un error. Como siempre, la calidad importa.

Estas son algunas de las características que un buen código generado debería tener:

• Independiente: el código manual y el generado deben estar en archivos diferentes, de lo contrario se corre el riesgo de perder el primero en el caso de que tengamos que volver a generar el código (y sucederá).
• Inmutable: no se debe cambiar, por dos razones: es peligroso, por ser desconocido, y por la misma razón que en el caso anterior.
• Legible: eso significa: nombres de variables y funciones significativos, comentarios, sangría, organizados en carpetas, archivos, etc. El código generado debe estar presentable para recibir la visita de los desarrolladores: para saber cómo funciona y ¿por qué no?, para aprender de él. Debemos generar un código del que sentirnos orgullosos.
• Extensible: por diferentes razones es posible que tenga que implementar manualmente algunas funcionalidades, por lo que el código generado debe dejar algunas puertas abiertas. La mejor manera es diseñar el código generado como un Framework, donde el código manual puede extender sólo algunas funcionalidades permitidas y en un entorno seguro.
• Estructurada: elevar el nivel de abstracción requiere un buen conocimiento del campo que se está tratando. Un código mal estructurado puede ser un síntoma de que ese campo no está completamente bajo control. Una buena generación de código requiere un buen arquitecto.
• Robusto: el código generado puede fallar, por supuesto. El control de errores, la gestión de excepciones, la validación de las entradas, validaciones internas, etc deben ir siempre incluidas en el código. Este tipo de políticas de seguridad se pueden implementar fácilmente en la generación de código y debe ser una de las razones de su calidad.
• Potente: una vez dicho lo anterior, deberíamos ver la generación de código como una forma de escribir un código más potente, eso significa pensar en estrategias, en el código generado, que nunca usaríamos si lo hiciéramos a mano (por lo general por razones de mantenimiento).

En resumen, las buenas prácticas en la generación de código son una mezcla de las buenas prácticas tradicionales y una forma más amplia de pensar.
 

Ver todos los posts Teórico.