3 Pilares básicos en la programación
En mi experiencia como programador he tenido que topar con toda clase de compañeros y con ellos sus practicas de programación, algunos ordenados y con prestigiosas prácticas, otros con excentricos y banales fenómenos de codificación y otros cuyos artilugios no tienen forma por donde quieras que lo veas y el próximo (incluyendo) que le de mantenimiento va pasar un mal rato, no solo entendiendo el problema, si no tratando de leer (entender es demasiado pedir) el código maléfico.
Existen muchas prácticas, pero entre mis favoritas se encuentran las siguientes 3:
1) Declarar todas las variables al inicio del bloque:
Es imposible que la gente ande declarando una variable donde sea, apenas la necesita.
Esta técnica aparte del orden que ya gana, permite saltarse de primera instancia la declaración de las variables para ir a la invariante de la clase, sin que esta se pudra con código de declaraciones, además es mas sencillo reutilizar o liberar las variables en diferentes "scopes" en el mismo método.
2) Inicializar las variables:
Esta es otra practica importante y casi que viene de la mano con la primera, aunque puede parecer una cuestión de estética, sin duda es una buena practica pues nos permite además definir el punto de partida, además si el valor puede tener un valor inicial con más sentido que un "null", así pues ya es mas que funcional.
3) Un solo punto de retorno:
Esto aplica en caso que la función tenga un valor de retorno, en lenguajes como Groovy o Perl en donde se puede omitir el ultimo retorno, tomando por dada la ultima variable utilizada en el método quizá no sea del todo funcional, pero en los lenguajes que carecen de esta característica, proporciona un legibilidad muy pero muy valiosa. El hecho de tener hasta 10 instrucciones "return" en el código hace caótico el entendimiento, además que a razón de eficiencia esto puede afectar el predictor del pipeline del hardware, pues una instrucción de retorno que no se encuentra al final de la operación, provoca que las siguientes N instrucciones predecidas sean sacadas del pipeline por la interrupción inesperada.
Como se podrá dar cuenta, son simples consejos e inclusive se pueden ver como puntos triviales o super básicos para un programador, pero deben creerme, pasa y mucho.
Cuando digites código, por favor ponte en los zapatos del pobre que tendrá que darle mantenimiento y apiadate de él.
Comentarios
Siempre es bueno acatar los code conventions ya establecidos, tanto para código como para documentacion, y al final puedes facilmente generar un javadoc que ayuda muchisisimo al entendimiento de las aplicaciones.